Skip to content

Commit

Permalink
Merge pull request #1518 from rmartin16/docs-tweaks
Browse files Browse the repository at this point in the history 
Docs tweaks
  • Loading branch information
@freakboy3742
freakboy3742 authored Oct 31, 2023
2 parents e4411b1 + 669ea05 commit ccd1c7c
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 43 deletions.
1 change: 1 addition & 0 deletions changes/1518.misc.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The docs linting process no longer verifies hyperlinks the Briefcase GitHub repo and the platform support table is now uniform.
26 changes: 15 additions & 11 deletions docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,21 @@
"^/dev[0-9a-f]{9}$"
]

linkcheck_ignore = [
r"^./android/gradle.html$",
r"^./iOS/xcode.html$",
r"^./linux/appimage.html$",
r"^./linux/flatpak.html$",
r"^./linux/system.html$",
r"^./macOS/app.html$",
r"^./macOS/xcode.html$",
r"^./web/static.html$",
r"^./windows/app.html$",
r"^./windows/visualstudio.html$",
r"^https://github.com/beeware/briefcase/issues/\d+$",
r"^https://github.com/beeware/briefcase/pull/\d+$",
]

# -- Options for copy button ---------------------------------------------------

# virtual env prefix: (venv), (beeware-venv), (testenv)
Expand Down Expand Up @@ -320,17 +335,6 @@
# Location of word list.
spelling_word_list_filename = "spelling_wordlist"

# -- Options for link check -------------------------------------------

linkcheck_ignore = [
r"./android/gradle.html",
r"./iOS/xcode.html",
r"./linux/system.html",
r"./macOS/app.html",
r"./web/static.html",
r"./windows/app.html",
]

# -- Options for Todos -------------------------------------------

# If this is True, todo and todolist produce output, else they produce nothing. The default is False.
Expand Down
76 changes: 44 additions & 32 deletions docs/reference/platforms/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,48 +23,60 @@ Platform support
+-----+-------------------------------------+


.. |Gradle| replace:: **Gradle**
.. |Gradle| replace:: **Gradle project**
.. _Gradle: ./android/gradle.html

.. |iOS| replace:: **Xcode**
.. |iOS| replace:: **Xcode project**
.. _iOS: ./iOS/xcode.html

.. |System| replace:: **Native System Packages**
.. |AppImage| replace:: AppImage
.. _AppImage: ./linux/appimage.html

.. |Flatpak| replace:: Flatpak
.. _Flatpak: ./linux/flatpak.html

.. |System| replace:: **System package**
.. _System: ./linux/system.html

.. |macOSApp| replace:: **.app bundle**
.. _macOSApp: ./macOS/app.html

.. |windowsApp| replace:: **Windows app**
.. _windowsApp: ./windows/app.html
.. |Xcode| replace:: Xcode project
.. _Xcode: ./macOS/xcode.html

.. |Web| replace:: **Static**
.. _Web: ./web/static.html

+---------+--------------------------------------+--------+-------+---------+--------+---+-----+--------+-----+-------+
| 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| | |v| |
+---------+--------------------------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| iOS | |iOS|_ | |f| | |y| | | | | | | | |
+---------+--------------------------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| Linux | :doc:`./linux/appimage` | |v| | | | | | |v| | |v| | | |
+ +--------------------------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| | :doc:`./linux/flatpak` | | | | | | |v| | |f| | |v| | |v| |
+ +--------------------------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| | |System|_ | |y| | |y| | | | | |v| | |f| | |v| | |v| |
+---------+--------------------------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| macOS | |macOSApp|_ | |f| | |y| | | | | | | | |
+ +--------------------------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| | :doc:`Xcode project <./macOS/xcode>` | |f| | |y| | | | | | | | |
+---------+--------------------------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| Web | |web|_ | |f| | |y| | |v| | |f| | |v| | |v| | |f| | |v| | |v| |
+---------+--------------------------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| Windows | |windowsApp|_ | | | | |f| | | | | | |
+ +--------------------------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| | :doc:`./windows/visualstudio` | | | | |f| | | | | | |
+---------+--------------------------------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
.. |WindowsApp| replace:: **Windows app**
.. _WindowsApp: ./windows/app.html

.. |VisualStudio| replace:: Visual Studio project
.. _VisualStudio: ./windows/visualstudio.html

+---------+-----------------+--------+-------+---------+--------+---+-----+--------+-----+-------+
| 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| | |v| |
+---------+-----------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| iOS | |iOS|_ | |f| | |y| | | | | | | | |
+---------+-----------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| Linux | |AppImage|_ | |v| | | | | | |v| | |v| | | |
+ +-----------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| | |Flatpak|_ | | | | | | |v| | |f| | |v| | |v| |
+ +-----------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| | |System|_ | |y| | |y| | | | | |v| | |f| | |v| | |v| |
+---------+-----------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| macOS | |macOSApp|_ | |f| | |y| | | | | | | | |
+ +-----------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| | |Xcode|_ | |f| | |y| | | | | | | | |
+---------+-----------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| Web | |Web|_ | |f| | |y| | |v| | |f| | |v| | |v| | |f| | |v| | |v| |
+---------+-----------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| Windows | |WindowsApp|_ | | | | |f| | | | | | |
+ +-----------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+
| | |VisualStudio|_ | | | | |f| | | | | | |
+---------+-----------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+

0 comments on commit ccd1c7c

Please sign in to comment.