ntd2d_action.sphinxdocs

Sphinx configuration directory.

Classes

class ntd2d_action.sphinxdocs.BorgedSphinxDocs(original_docs)

Bases: SphinxDocs

Sphinx configuration directory modified by Docs4NIST

Parameters:

original_docs (SphinxDocs) – The configuration directory stored in the Repository.

assimilate_theme(name, insert_header_footer=True)

Replace configuration directory with customized html theme.

build_docs(build_command)

Build Sphinx Documentation

Adapted from https://github.com/ammaraskar/sphinx-action/blob/master/sphinx_action/action.py (Apache-2.0).

property inherited_layout

Find inherited layout.html

Inherited theme may not define its own layout.html, but rely on a theme that it, in turn, derives from. {% extends “!layout.html” %} should work, but doesn’t. https://github.com/sphinx-doc/sphinx/issues/12049

---

class ntd2d_action.sphinxdocs.SphinxDocs(docs_dir)

Bases: object

Sphinx configuration directory.

build_docs(build_command)

Build Sphinx Documentation

Adapted from https://github.com/ammaraskar/sphinx-action/blob/master/sphinx_action/action.py (Apache-2.0).