mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-24 05:36:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Fixed #32720 -- Added configuration and docs for Sphinx link checker.

Browse source 
We explicitly ignore checking anchors for line-range anchors on GitHub
which are dynamically generated and, otherwise, show up as broken links.

See https://github.com/sphinx-doc/sphinx/issues/7388#issuecomment-739961689.

We also ignore links to resources that require authentication.
This commit is contained in:
Nick Pope 2021-04-27 11:57:59 +01:00 • committed by Mariusz Felisiak
parent c156e36955
commit 0851933cba
3 changed files with 47 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/internals/contributing/writing-documentation.txt
View file

@ -510,6 +510,28 @@ one of the following:
* If, and only if, you are sure the word you are using is correct - add it
to ``docs/spelling_wordlist`` (please keep the list in alphabetical order).
.. _documentation-link-check:
Link check
==========
Links in documentation can become broken or changed such that they are no
longer the canonical link. Sphinx provides a builder that can check whether the
links in the documentation are working. From the ``docs`` directory, run ``make
linkcheck``. Output is printed to the terminal, but can also be found in
``_build/linkcheck/output.txt`` and ``_build/linkcheck/output.json``.
Entries that have a status of "working" are fine, those that are "unchecked" or
"ignored" have been skipped because they either cannot be checked or have
matched ignore rules in the configuration.
Entries that have a status of "broken" need to be fixed. Those that have a
status of "redirected" may need to be updated to point to the canonical
location, e.g. the scheme has changed ``http://`` → ``https://``. In certain
cases, we do not want to update a "redirected" link, e.g. a rewrite to always
point to the latest or stable version of documentation, e.g. ``/en/stable/`` →
``/en/3.2/``.
Translating documentation
=========================

6
docs/internals/howto-release-django.txt
View file

@ -103,9 +103,9 @@ any time leading up to the actual release:
#. Check with the other committers to make sure they don't have any
uncommitted changes for the release.
#. Proofread the release notes, including looking at the online
version to catch any broken links or reST errors, and make sure the
release notes contain the correct date.
#. Proofread the release notes, including looking at the online version to
:ref:`catch any broken links <documentation-link-check>` or reST errors, and
make sure the release notes contain the correct date.
#. Double-check that the release notes mention deprecation timelines
for any APIs noted as deprecated, and that they mention any changes