Building the documentation¶
So meta. First of, activate your virtualenv and install dedicated dependencies:
$ pip install -r requirements/doc.pip
Then you should be able to build and serve the documentation using the dedicated invoke task:
$ inv doc
Open http://127.0.0.1:8000/ and enjoy the live reload of your changes.
Docs are located within the
udata/docs/* directory and use the markdown format.
Behind the scene, it uses MkDocs so feel free to use directly for advanced usage:
$ mkdocs --help