boilercore_docs

Documentation tools.

Submodules

• boilercore_docs.settings
• boilercore_docs.format
• boilercore_docs.nbs
• boilercore_docs.intersphinx
• boilercore_docs.docstrings
• boilercore_docs.patch_nbs
• boilercore_docs.types

Package Contents

Functions

chdir_docs	Ensure we are in the docs directory and return the root directory.
get_root	Get the project root directory.

Data

DOCS	Docs directory.
DEPS	Dependencies shared with tests.
PYPROJECT	Path to pyproject.toml.
CHECKS	Checks for the root directory.

API

boilercore_docs.DOCS

‘Path(…)’

Docs directory.

boilercore_docs.DEPS

‘Path(…)’

Dependencies shared with tests.

boilercore_docs.PYPROJECT

‘Path(…)’

Path to pyproject.toml.

boilercore_docs.CHECKS

None

Checks for the root directory.

boilercore_docs.chdir_docs() → pathlib.Path

Ensure we are in the docs directory and return the root directory.

boilercore_docs.get_root() → pathlib.Path

Get the project root directory.