Skip to content
Snippets Groups Projects
Commit ba33c544 authored by Paul Sokolovsky's avatar Paul Sokolovsky
Browse files

docs/conf.py: Set default_role = 'any'.

This causes `symbol` syntax to be equivalent to :any:`symbol`, which is
in turn the easiest way to cross-reference an arbitrary symbol in the
docs:

http://www.sphinx-doc.org/en/stable/markup/inline.html#role-any

:any: requires at least Sphinx 1.3 (for reference, Ubuntu 16.03 ships
with 1.3.6, the latest 1.6.3).

Any many of our docs, `symbol` is misused to specify arguments to
functions, etc. Refactoring that is in progress. (CODECONVENTIONS
already specify proper syntax for both arguments and xrefs, based
on CPython conventions).
parent 6f87b03e
Branches master
No related tags found
No related merge requests found
...@@ -117,7 +117,7 @@ exclude_patterns = ['build'] ...@@ -117,7 +117,7 @@ exclude_patterns = ['build']
# The reST default role (used for this markup: `text`) to use for all # The reST default role (used for this markup: `text`) to use for all
# documents. # documents.
#default_role = None default_role = 'any'
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True #add_function_parentheses = True
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment