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:

Attributes Summary

author

A plaintext expression of the author or authors.

jinja_context

The TechnoteJinjaContext that provides metadata to the HTML templates.

nitpicky

The nitpicky boolean flag.

title

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

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.

jinja_context

The TechnoteJinjaContext that provides metadata to the HTML templates.

nitpicky

The nitpicky boolean flag.

title

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

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