Skip to content

Commit

Permalink
docs: (Sphinx) enable autosectionlabel_prefix_document
Browse files Browse the repository at this point in the history
Using this option, the autosectionlabel extension
prefix every autolabel with the document.
This removes around 100 warnings.
  • Loading branch information
joergsteffens committed Feb 10, 2019
1 parent c412199 commit 330c85a
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions docs/manuals/en/new_main_reference/source/conf.py
Expand Up @@ -47,17 +47,22 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
#extensions = ['sphinxcontrib.plantuml']
extensions = ['sphinx.ext.todo',
'sphinx.ext.coverage',
extensions = [
'sphinx_issues',
'sphinx.ext.autosectionlabel',
'sphinxcontrib.plantuml',
'sphinx.ext.coverage',
'sphinx.ext.todo',
'sphinxcontrib.actdiag',
'sphinxcontrib.blockdiag',
'sphinxcontrib.nwdiag',
'sphinxcontrib.plantuml',
'sphinxcontrib.seqdiag',
'sphinxcontrib.actdiag',
'sphinx_issues',
]
]

# True to prefix each section label with the name of the document it is in, followed by a colon.
# For example, index:Introduction for a section called Introduction that appears in document index.rst.
# Useful for avoiding ambiguity when the same section heading appears in different documents.
autosectionlabel_prefix_document = True

issues_uri = 'https://bugs.bareos.org/view.php?id={issue}'
issues_pr_uri = 'https://github.com/bareos/bareos/pull/{pr}'
Expand Down

0 comments on commit 330c85a

Please sign in to comment.