Skip to content

Commit 149e466

Browse files
authored
docs - anchor links (#848)
* docs - add links * add desc.
1 parent c48541d commit 149e466

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/source/conf.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -359,4 +359,15 @@ def find_source():
359359
'private-members': True,
360360
}
361361

362+
# Sphinx will add “permalinks” for each heading and description environment as paragraph signs that
363+
# become visible when the mouse hovers over them.
364+
# This value determines the text for the permalink; it defaults to "¶". Set it to None or the empty
365+
# string to disable permalinks.
366+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_add_permalinks
362367
html_add_permalinks = True
368+
369+
# True to prefix each section label with the name of the document it is in, followed by a colon.
370+
# For example, index:Introduction for a section called Introduction that appears in document index.rst.
371+
# Useful for avoiding ambiguity when the same section heading appears in different documents.
372+
# http://www.sphinx-doc.org/en/master/usage/extensions/autosectionlabel.html
373+
autosectionlabel_prefix_document = True

0 commit comments

Comments
 (0)