API Reference¶
Directive reference¶
Generated from app.add_directive() registrations in
sphinx_autodoc_docutils/__init__.py
via the package’s own bulk directive — every auto* pair documents
itself.
-
.. autodirective::¶.. autodirective::¶
Render documentation for a single directive class.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autodirectives::¶.. autodirectives::¶
Render documentation for every directive a package registers.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autorole::¶.. autorole::¶
Render documentation for a single role callable.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autoroles::¶.. autoroles::¶
Render documentation for every role a package registers.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autotransform::¶.. autotransform::¶
Render documentation for a single transform class.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autotransforms::¶.. autotransforms::¶
Render documentation for every transform a package registers.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autoreader::¶.. autoreader::¶
Render documentation for a single reader class.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autoreaders::¶.. autoreaders::¶
Render documentation for every reader class a module defines.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autoparser::¶.. autoparser::¶
Render documentation for a single parser class.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autoparsers::¶.. autoparsers::¶
Render documentation for every parser a module defines or registers.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autowriter::¶.. autowriter::¶
Render documentation for a single writer class.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autowriters::¶.. autowriters::¶
Render documentation for every writer class a module defines.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autonode::¶.. autonode::¶
Render documentation for a single node class.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autonodes::¶.. autonodes::¶
Render documentation for every node a module defines or registers.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
-
.. autotranslator::¶.. autotranslator::¶
Render documentation for a single translator class.
Options:
- Python path:
- Required arguments:
1- Optional arguments:
0- Final argument whitespace:
False- Has content:
False
Cross-reference roles¶
The extension registers a docutils Sphinx domain. Every component
entry rendered without :no-index: becomes a link target for the
matching role:
Role |
Links to |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
Targets accept the fully-qualified dotted path
({docutils:transform}`pkg.transforms.Sanitize`) or the bare class
name when it is unambiguous across the project. Dangling references
warn at build time.
The domain also ships a grouped components index: Docutils components index.
Extension entry point¶
-
sphinx_autodoc_docutils.setup(app)¶sphinx_autodoc_docutils.setup(app)¶
Register docutils directive and role autodoc directives.
Examples
>>> class FakeApp: ... def __init__(self) -> None: ... self.calls: list[tuple[str, object]] = [] ... def setup_extension(self, name: str) -> None: ... self.calls.append(("setup_extension", name)) ... def add_directive(self, name: str, directive: object) -> None: ... self.calls.append(("add_directive", name)) ... def add_domain(self, domain: object) -> None: ... self.calls.append(("add_domain", domain)) ... def connect(self, event: str, handler: object) -> None: ... self.calls.append(("connect", event)) ... def add_css_file(self, filename: str) -> None: ... self.calls.append(("add_css_file", filename)) >>> fake = FakeApp() >>> metadata = setup(fake) # type: ignore[arg-type] >>> ("add_directive", "autodirective") in fake.calls True >>> ("add_directive", "autotransform") in fake.calls True >>> ("add_domain", DocutilsDomain) in fake.calls True >>> ("setup_extension", "sphinx_ux_autodoc_layout") in fake.calls True >>> ("add_css_file", "css/sphinx_autodoc_docutils.css") in fake.calls True >>> metadata["parallel_read_safe"] True
- Parameters:
app (
Sphinx)- Return type: