boilercine_docs

Documentation tools.

Submodules

• boilercine_docs.docstrings
• boilercine_docs.types
• boilercine_docs.intersphinx

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.
PYPROJECT	Path to pyproject.toml.
CHECKS	Checks for the root directory.

API

boilercine_docs.DOCS

‘Path(…)’

Docs directory.

boilercine_docs.PYPROJECT

‘Path(…)’

Path to pyproject.toml.

boilercine_docs.CHECKS

None

Checks for the root directory.

boilercine_docs.chdir_docs() → pathlib.Path

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

boilercine_docs.get_root() → pathlib.Path

Get the project root directory.