index.rst

Overview

sphinx-toolbox

sphinx.ext.viewcode sphinx_tabs.tabs sphinx-prompt

The following features are enabled by default:

• sphinx_toolbox.assets
• sphinx_toolbox.changeset
• sphinx_toolbox.code
• sphinx_toolbox.collapse
• sphinx_toolbox.confval
• sphinx_toolbox.decorators
• sphinx_toolbox.formatting
• sphinx_toolbox.github
• sphinx_toolbox.installation
• sphinx_toolbox.issues
• sphinx_toolbox.latex
• sphinx_toolbox.rest_example
• sphinx_toolbox.shields *
• sphinx_toolbox.sidebar_links
• sphinx_toolbox.source
• sphinx_toolbox.wikipedia
• sphinx_toolbox.more_autodoc.autonamedtuple
• sphinx_toolbox.more_autodoc.autoprotocol
• sphinx_toolbox.more_autodoc.autotypeddict

* Indicates that the extension cannot be enabled separately from the rest of sphinx_toolbox.

Some features must be enabled separately:

• sphinx_toolbox.more_autodoc

  • sphinx_toolbox.more_autodoc.augment_defaults
  • sphinx_toolbox.more_autodoc.generic_bases
  • sphinx_toolbox.more_autodoc.genericalias
  • sphinx_toolbox.more_autodoc.no_docstring
  • sphinx_toolbox.more_autodoc.overloads
  • sphinx_toolbox.more_autodoc.regex
  • sphinx_toolbox.more_autodoc.sourcelink
  • sphinx_toolbox.more_autodoc.typehints
  • sphinx_toolbox.more_autodoc.typevars
  • sphinx_toolbox.more_autodoc.variables

  sphinx_toolbox.more_autodoc can also be specified as an extension, which enables all of the above features.

• sphinx_toolbox.more_autosummary

  Provides a patched version of sphinx.ext.autosummary.Autosummary to fix an issue where the module name is sometimes duplicated.

  I.e. foo.bar.baz() became foo.bar.foo.bar.baz(), which of course doesn't exist and created a broken link.