Documentation ¶

Documentation is developed using the Python package mkdocs.

Installing ¶

The requirements for building the documentation are the same as those for the tm2py package.

Building Locally ¶

Mkdocs documentation webpages can be built locally and viewed at the URL specified in the terminal:

mkdocs serve

Linting ¶

Documentation should be linted before deployment:

pre-commit run --all-files
pre-commit run --hook-stage manual --all-files

Deploying documentation ¶

Documentation is built and deployed to [http://bayareametro.github.io/tm2py] using the mike package and Github Actions configured in .github/workflows/ for each “ref” (i.e. branch) in the tm2py repository.