boilerdaq_docs#

Documentation tools.

Submodules#

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#

boilerdaq_docs.DOCS#

‘Path(…)’

Docs directory.

boilerdaq_docs.PYPROJECT#

‘Path(…)’

Path to pyproject.toml.

boilerdaq_docs.CHECKS#

None

Checks for the root directory.

boilerdaq_docs.chdir_docs() pathlib.Path#

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

boilerdaq_docs.get_root() pathlib.Path#

Get the project root directory.