Skip to content

Commit

Permalink
Add sphinx default role (#59)
Browse files Browse the repository at this point in the history
* Add sphinx default role

* Add a place for people to add other options
  • Loading branch information
Cadair authored Mar 1, 2024
1 parent 15b1c12 commit cc1e504
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions {{ cookiecutter.package_name }}/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@
# The master toctree document.
master_doc = "index"

# Treat everything in single ` as a Python reference.
default_role = 'py:obj'

# -- Options for intersphinx extension ---------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
Expand All @@ -75,3 +78,5 @@
# the docs. For more options, see:
# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autoclass_content
autoclass_content = "both"

# -- Other options ----------------------------------------------------------

0 comments on commit cc1e504

Please sign in to comment.