Skip to content

Commit

Permalink
Refs #32720 -- Added documentation for Sphinx linkcheck builder.
Browse files Browse the repository at this point in the history
  • Loading branch information
ngnpope committed May 6, 2021
1 parent 0663484 commit 10dfa08
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
25 changes: 25 additions & 0 deletions docs/internals/contributing/writing-documentation.txt
Expand Up @@ -510,6 +510,31 @@ 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`` or, if you need to process the output, you can
use ``_build/linkcheck/output.json`` which is in `JSON Lines`__ format..

__ https://jsonlines.org/

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
=========================

Expand Down
3 changes: 2 additions & 1 deletion docs/internals/howto-release-django.txt
Expand Up @@ -105,7 +105,8 @@ any time leading up to the actual 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.
release notes contain the correct date. (Use the `linkcheck builder
<documentation-link-check>`_ to assist with checking for broken links.)

#. Double-check that the release notes mention deprecation timelines
for any APIs noted as deprecated, and that they mention any changes
Expand Down

0 comments on commit 10dfa08

Please sign in to comment.