TechnoteSphinxConfig#

class technote.main.TechnoteSphinxConfig(factory, toml, metadata, root_filename)#

Bases: object

A class that configures Sphinx in conf.py to build a technote.

Parameters:

factory (Factory)
toml (TechnoteToml)
metadata (TechnoteMetadata)
root_filename (Path)

Attributes Summary

`author`	A plaintext expression of the author or authors.
`factory`
`jinja_context`	The TechnoteJinjaContext that provides metadata to the HTML templates.
`metadata`	The metadata for the technote.
`nitpicky`	The nitpicky boolean flag.
`root_filename`	Path to the root content document.
`title`	The title of the document set via technote.toml metadata, or None if the document's H1 should be used.
`toml`	The parse `technote.toml` file.

Methods Summary

`append_extensions`(extensions)	Append user-configured extensions to an existing list.
`append_linkcheck_ignore`(link_patterns)	Append URL patterns for sphinx.linkcheck.ignore to existing patterns.
`append_nitpick_ignore`(nitpick_ignore)	Append `nitpick_ignore` items from sphinx.nitpick_ignore.
`append_nitpick_ignore_regex`(nitpick_ignore_regex)	Append `nitpick_ignore_regex` items from sphinx.nitpick_ignore.
`extend_intersphinx_mapping`(mapping)	Extend the `intersphinx_mapping` dictionary with configured projects.
`load`()	Create a TechnoteSphinxConfig from the current directory.

Attributes Documentation

author#: A plaintext expression of the author or authors.

factory: Factory = <dataclasses._MISSING_TYPE object>#

jinja_context#: The TechnoteJinjaContext that provides metadata to the HTML templates.

metadata: TechnoteMetadata = <dataclasses._MISSING_TYPE object>#

The metadata for the technote.

This metadata is principally obtained from the technote.toml settings file, but is augmented from content within the technote itself and from external sources.

nitpicky#: The nitpicky boolean flag.

root_filename: Path = <dataclasses._MISSING_TYPE object>#

Path to the root content document.

Typically either index.md, index.rst, or index.ipynb.

title#: The title of the document set via technote.toml metadata, or None if the document’s H1 should be used.

toml: TechnoteToml = <dataclasses._MISSING_TYPE object>#: The parse technote.toml file.

Methods Documentation

append_extensions(extensions)#

Append user-configured extensions to an existing list.

Parameters:: extensions (list[str])
Return type:: None

append_linkcheck_ignore(link_patterns)#

Append URL patterns for sphinx.linkcheck.ignore to existing patterns.

Parameters:: link_patterns (list[str])
Return type:: None

append_nitpick_ignore(nitpick_ignore)#

Append nitpick_ignore items from sphinx.nitpick_ignore.

Parameters:: nitpick_ignore (list[tuple[str, str]])
Return type:: None

append_nitpick_ignore_regex(nitpick_ignore_regex)#

Append nitpick_ignore_regex items from sphinx.nitpick_ignore.

Parameters:: nitpick_ignore_regex (list[tuple[str, str]])
Return type:: None

extend_intersphinx_mapping(mapping)#

Extend the intersphinx_mapping dictionary with configured projects.

Parameters:: mapping (MutableMapping[str, tuple[str, str | None]])
Return type:: None

classmethod load()#

Create a TechnoteSphinxConfig from the current directory.

Return type:: TechnoteSphinxConfig