From 0e4707d68cb2b0c0640ca25c6467845075c74dc1 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Tue, 29 Oct 2024 14:58:00 -0700 Subject: [PATCH 1/3] Fix docs warnings and broken links Also enables checking for this in the future. --- .readthedocs.yml | 4 +--- docs/user/flyout-menu.rst | 6 +++--- docs/user/pull-requests.rst | 2 +- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index ac2c56f6d29..f4c5e7f6034 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -6,9 +6,7 @@ formats: sphinx: configuration: docs/conf.py - - # Disabled due to temporary issue with Django docs - fail_on_warning: false + fail_on_warning: True python: install: diff --git a/docs/user/flyout-menu.rst b/docs/user/flyout-menu.rst index a898164281f..dc2b0d33e5b 100644 --- a/docs/user/flyout-menu.rst +++ b/docs/user/flyout-menu.rst @@ -12,7 +12,7 @@ without having to have the documentation theme integrate it directly. The flyout menu is a default implementation that works for every site. You can access the full data used to construct the flyout, and use that to integrate the data directly into your documentation theme for a nicer user experience. - See the :ref:`Custom event integration` for more information. + See the :ref:`flyout-menu:Custom event integration` for more information. Addons flyout menu ------------------ @@ -20,7 +20,7 @@ Addons flyout menu The :doc:`addons` flyout provides a place for a number of Read the Docs features: * A :doc:`version switcher ` that shows users all of the active versions they have access to. -* A :doc:`translation switcher ` that shows all the documentation languages provided. +* A :doc:`translation switcher ` that shows all the documentation languages provided. * A list of :doc:`offline formats ` for the current version, including HTML & PDF downloads. * Links to the Read the Docs dashboard for the project. * A search bar that gives users access to the :doc:`/server-side-search/index` of the current version. @@ -57,7 +57,7 @@ Custom event integration Read the Docs Addons exposes all the data used to construct the flyout menu via a JavaScript ``CustomEvent``. If you'd like to integrate the data, -you can use the :ref:`mkdocs:Integrate the Read the Docs version menu into your site navigation` example as a starting point. +you can use the :ref:`intro/mkdocs:Integrate the Read the Docs version menu into your site navigation` example as a starting point. .. warning:: We have not formally documented the API response returned from the Addons API, diff --git a/docs/user/pull-requests.rst b/docs/user/pull-requests.rst index 66a5d89b881..afa8a16104b 100644 --- a/docs/user/pull-requests.rst +++ b/docs/user/pull-requests.rst @@ -28,7 +28,7 @@ Pull request notifications A pull request notifications is shown at the top of preview pages, which let readers know they aren't viewing an active version of the project. -:doc:`DocDiff `` +:doc:`DocDiff ` DocDiff shows proposed changes by visually highlighting the differences between the current pull request and the latest version of the project's documentation. Press ``d`` to toggle between DocDiff and normal pull request preview. From 966baff7bd6a287bc77fcb6585c66aa041412729 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Tue, 29 Oct 2024 15:22:21 -0700 Subject: [PATCH 2/3] Fix dev docs too --- docs/dev/design/yaml-file.rst | 1 - docs/dev/install.rst | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/dev/design/yaml-file.rst b/docs/dev/design/yaml-file.rst index 4deff016859..4b004b7cfe9 100644 --- a/docs/dev/design/yaml-file.rst +++ b/docs/dev/design/yaml-file.rst @@ -157,4 +157,3 @@ Footnotes .. [#project-description] https://github.com/readthedocs/readthedocs.org/issues/3689 .. [#yaml-spec] https://yaml.org/spec/1.2/spec.html .. [#specversioning] https://github.com/readthedocs/readthedocs.org/issues/3806 -.. [#one-checkout] https://github.com/readthedocs/readthedocs.org/issues/1375 diff --git a/docs/dev/install.rst b/docs/dev/install.rst index b323f94bca1..4f5d710e0e7 100644 --- a/docs/dev/install.rst +++ b/docs/dev/install.rst @@ -243,7 +243,7 @@ using your GitHub, Bitbucket, or GitLab credentials and this makes the process of importing repositories easier. However, because these services will not be able to connect back to your local development instance, -:doc:`incoming webhooks ` will not function correctly. +:doc:`incoming webhooks ` will not function correctly. For some services, the webhooks will fail to be added when the repository is imported. For others, the webhook will simply fail to connect when there are new commits to the repository. From ed2083d6dcdb8ca90ec97fb268d93604aad1e8c4 Mon Sep 17 00:00:00 2001 From: Eric Holscher <25510+ericholscher@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:45:34 -0700 Subject: [PATCH 3/3] Update .readthedocs.yml Co-authored-by: Santos Gallegos --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index f4c5e7f6034..4bfb8771d8a 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -6,7 +6,7 @@ formats: sphinx: configuration: docs/conf.py - fail_on_warning: True + fail_on_warning: true python: install: