IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

#4886 adjust documentation to match actual link check behavior

Browse Source
This commit is contained in:
Timotheus Kampik 2018-07-16 23:22:26 +02:00
parent c126067f4e
commit 537a69e518
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/usage/configuration.rst
View File

@ -2485,12 +2485,20 @@ Options for the linkcheck builder
.. confval:: linkcheck_anchors_ignore
A list of regular expressions that match URIs that should skip checking
the validity of anchors in links. This allows skipping entire sites, where
anchors are used to control dynamic pages, or just specific anchors within
a page, where JavaScript is used to add anchors dynamically, or use the
fragment as part of to trigger an internal REST request. Default is
``["/#!"]``.
A list of regular expressions that match anchors Sphinx should skip when
checking the validity of anchors in links. This allows skipping anchors that
a website's JavaScript adds to control dynamic pages or when triggering an
internal REST request. Default is ``["^!"]``.
.. note::
If you want to ignore anchors of a specific page or of pages that match a
specific pattern, use :confval:`linkcheck_ignore` instead, for example as
follows::
linkcheck_ignore = [
'http://www.sphinx-doc.org/en/1.7/intro.html#*'
]
.. versionadded:: 1.5