diff --git a/docs/conf.py b/docs/conf.py index 8272744c7..62dbe1c65 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -97,6 +97,16 @@ intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} +# API status indicators. +rst_prolog = """ +.. role:: full +.. role:: yes +.. role:: ymmv +.. |f| replace:: :full:`●` +.. |y| replace:: :yes:`○` +.. |v| replace:: :ymmv:`■` +""" + # -- Options for link checking ------------------------------------------------- linkcheck_anchors_ignore = [ diff --git a/docs/reference/platforms/index.rst b/docs/reference/platforms/index.rst index 929d02e49..ed1a6cf99 100644 --- a/docs/reference/platforms/index.rst +++ b/docs/reference/platforms/index.rst @@ -2,8 +2,10 @@ Platform support ================ +.. _api-status-key: + .. toctree:: - :maxdepth: 2 + :maxdepth: 1 macOS/index windows/index @@ -11,3 +13,34 @@ Platform support iOS android web + +Supported Host Platforms +======================== + ++---------+------------------+--------+-------+---------+--------+---+-----+--------+-----+-------+ +| Target App Format | Host System | ++ +--------+-------+---------+--------+---+-----+--------+-----+-------+ +| | macOS | Windows | Linux | ++ +--------+-------+-----+--------+-------+-----+--------+-----+-------+ +| | x86-64 | arm64 | x86 | x86-64 | arm64 | x86 | x86-64 | arm | arm64 | ++=========+==================+========+=======+=====+========+=======+=====+========+=====+=======+ +| Android | Gradle | |f| | |y| | | |f| | | |v| | |f| | |v| | |y| | ++---------+------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+ +| iOS | Xcode | |f| | |y| | | | | | | | | ++---------+------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+ +| Linux | AppImage | |f| | | | | | |y| | |f| | | | ++ +------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+ +| | Flatpak | | | | | | |v| | |f| | |v| | |y| | ++ +------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+ +| | System | |y| | |y| | | | | |y| | |f| | |y| | |y| | ++---------+------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+ +| macOS | .app | |f| | |y| | | | | | | | | ++ +------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+ +| | Xcode | |f| | |y| | | | | | | | | ++---------+------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+ +| Windows | App | | | | |f| | | | | | | ++ +------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+ +| | Visual Studio | | | | |f| | | | | | | ++---------+------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+ +| Web | Static | |f| | |y| | |y| | |f| | |y| | |y| | |f| | |y| | |y| | ++---------+------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+