From 34c6a7269fe1970a64b1a1b87003b8172988e837 Mon Sep 17 00:00:00 2001 From: Russell Martin Date: Tue, 31 Oct 2023 10:58:55 -0400 Subject: [PATCH 1/3] Do not link check Briefcase issues and PRs - Since every changenote in a Briefcase release includes a link to the GitHub issue/PR, link checking spends most of its time verifying well-known links...so, this omits them from docs linting. --- docs/conf.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 13395f64b..2cd293c76 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -115,6 +115,17 @@ "^/dev[0-9a-f]{9}$" ] +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", + 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) @@ -320,17 +331,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. From 8b92373f213f32e8cff9e6db2371f3774d7c22c9 Mon Sep 17 00:00:00 2001 From: Russell Martin Date: Tue, 31 Oct 2023 12:30:28 -0400 Subject: [PATCH 2/3] Standardize platform support table links --- changes/1518.misc.rst | 1 + docs/conf.py | 16 ++++--- docs/reference/platforms/index.rst | 76 +++++++++++++++++------------- 3 files changed, 55 insertions(+), 38 deletions(-) create mode 100644 changes/1518.misc.rst diff --git a/changes/1518.misc.rst b/changes/1518.misc.rst new file mode 100644 index 000000000..873e7cfd5 --- /dev/null +++ b/changes/1518.misc.rst @@ -0,0 +1 @@ +The docs linting process no longer verifies hyperlinks the Briefcase GitHub repo and the platform support table is now uniform. diff --git a/docs/conf.py b/docs/conf.py index 2cd293c76..24bb0414f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -116,12 +116,16 @@ ] 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", + 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+$", ] diff --git a/docs/reference/platforms/index.rst b/docs/reference/platforms/index.rst index c1bf1a335..c25f2e166 100644 --- a/docs/reference/platforms/index.rst +++ b/docs/reference/platforms/index.rst @@ -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| | | | | | | ++---------+-----------------+--------+-------+-----+--------+-------+-----+--------+-----+-------+ From 669ea05e04da8da8c1bc537d9ff7088e839d910e Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Wed, 1 Nov 2023 06:59:10 +0800 Subject: [PATCH 3/3] Remove bold from non-default options --- docs/reference/platforms/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/reference/platforms/index.rst b/docs/reference/platforms/index.rst index c25f2e166..fbce930dd 100644 --- a/docs/reference/platforms/index.rst +++ b/docs/reference/platforms/index.rst @@ -29,10 +29,10 @@ Platform support .. |iOS| replace:: **Xcode project** .. _iOS: ./iOS/xcode.html -.. |AppImage| replace:: **AppImage** +.. |AppImage| replace:: AppImage .. _AppImage: ./linux/appimage.html -.. |Flatpak| replace:: **Flatpak** +.. |Flatpak| replace:: Flatpak .. _Flatpak: ./linux/flatpak.html .. |System| replace:: **System package** @@ -41,7 +41,7 @@ Platform support .. |macOSApp| replace:: **.app bundle** .. _macOSApp: ./macOS/app.html -.. |Xcode| replace:: **Xcode project** +.. |Xcode| replace:: Xcode project .. _Xcode: ./macOS/xcode.html .. |Web| replace:: **Static** @@ -50,7 +50,7 @@ Platform support .. |WindowsApp| replace:: **Windows app** .. _WindowsApp: ./windows/app.html -.. |VisualStudio| replace:: **Visual Studio project** +.. |VisualStudio| replace:: Visual Studio project .. _VisualStudio: ./windows/visualstudio.html +---------+-----------------+--------+-------+---------+--------+---+-----+--------+-----+-------+