From 30a13bcaa7b0139c200458878a21e5467121fa34 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Mon, 27 Mar 2023 12:49:35 +0100 Subject: [PATCH 1/3] Add `--kep-going` to documentation build flags This ensures that all warnings are printed for Sphinx builds. --- noxfile.py | 1 + 1 file changed, 1 insertion(+) diff --git a/noxfile.py b/noxfile.py index 5c4683b7d79..565a5039955 100644 --- a/noxfile.py +++ b/noxfile.py @@ -133,6 +133,7 @@ def get_sphinx_build_command(kind: str) -> List[str]: # fmt: off return [ "sphinx-build", + "--keep-going", "-W", "-c", "docs/html", # see note above "-d", "docs/build/doctrees/" + kind, From 4fccbf0c74d252fd2301df397002c783ac6ad057 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Mon, 27 Mar 2023 12:50:43 +0100 Subject: [PATCH 2/3] Use a standard Sphinx document reference rather than Markdown syntax This avoids providing too much information or using weird mechanics to build across various MyST-Parser versions. --- docs/html/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/html/getting-started.md b/docs/html/getting-started.md index 0967b0eb99f..2b3f0bc9310 100644 --- a/docs/html/getting-started.md +++ b/docs/html/getting-started.md @@ -98,5 +98,5 @@ Successfully uninstalled sampleproject ## Next Steps It is recommended to learn about what virtual environments are and how to use -them. This is covered in the ["Installing Packages"](pypug:tutorials/installing-packages) +them. This is covered in the {doc}`Installing Packages ` tutorial on packaging.python.org. From 6810341fd010d721541e87ba3125b275d0108c45 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Mon, 27 Mar 2023 12:51:17 +0100 Subject: [PATCH 3/3] Bump to Sphinx 6 This is the current latest version of Sphinx. --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index fa3a7390c15..ef72c8fb722 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx ~= 4.2, != 4.4.0 +sphinx ~= 6.0 towncrier furo myst_parser