See here for more complete documentation
This repo has not yet been added to PyPI. See the developer installation below.
- git clone the repo
cdinto the local version of the repo- choose one (or more) of the following (only poetry currently supported)
You can also install the dependencies using poetry. I prefer setting the following:
poetry config virtualenvs.in-project trueSo that the virtual environments are installed in the project directory as .venv
After cloning and cding into the repo, you can install the dependencies with:
poetry installThe documentation is build with mkdocs:
mkdocs new [dir-name]- Create a new project.mkdocs serve- Start the live-reloading docs server.mkdocs build- Build the documentation site.mkdocs -h- Print help message and exit.
- mkdocs.yml # The configuration file.
- docs/
- index.md # The documentation homepage.
- ... # Other markdown pages, images and other files.
To update the gh-pages documentation, use poetry run mkdocs gh-deply