Skip to content

Latest commit

 

History

History
156 lines (96 loc) · 5.62 KB

README.rst

File metadata and controls

156 lines (96 loc) · 5.62 KB

sphinx_toolbox_experimental

Experimental Sphinx Extensions.

Tests Linux Test Status Windows Test Status macOS Test Status
Activity GitHub last commit GitHub commits since tagged version Maintenance
QA CodeFactor Grade Flake8 Status mypy status
Other License GitHub top language Requirements Status

Installation

sphinx-toolbox-experimental can be installed from GitHub.

To install with pip:

$ python -m pip install git+https://github.com/sphinx-toolbox/sphinx-toolbox-experimental

sphinx_toolbox_experimental.autosummary_widths

Sphinx extension to allow customisation of column widths in autosummary tables with the LaTeX builder.

sphinx_toolbox_experimental.changelog

Sphinx extension which generates a changelog from versionadded and versionchanged directives.

The changelog can be added with the changelog directive. The directive takes a single argument, the version number to display the changelog for.

sphinx_toolbox_experimental.missing_xref

Sphinx extension which ignores warnings about certain XRefs being unresolved. The warnings to ignore are determined by a list of patterns (for re.match) defined in the ignore_missing_xrefs option in conf.py.

sphinx_toolbox_experimental.needspace

Sphinx extension which configures the LaTeX needspace package. The default is to add \needspace{5\baselineskip} before each addnodes.desc node (i.e. a function or class description). The space can be adjusted with the needspace_amount option in conf.py.

sphinx_toolbox_experimental.rst_field

Sphinx extension to add a field directive to the rst domain for documenting a reST directive field..

sphinx_toolbox_experimental.html_section

Superseded by html-section.

sphinx_toolbox_experimental.succinct_seealso

Superseded by sphinx_toolbox.latex.succinct_seealso.

sphinx_toolbox_experimental.peps

Superseded by sphinx-packaging.peps.

sphinx_toolbox_experimental.toml

Superseded by sphinx-packaging.toml.