About These Docs¶
The Hydrus docs are built with MkDocs using the Material for MkDocs theme. The .md files in the
docs directory are converted into nice html in the
help directory. This is done automatically in the built releases, but if you run from source, you will want to build your own.
To see or work on the docs locally, install
The recommended installation method is
pip install mkdocs-material
To build the help, run:
mkdocs build -d help
mkdocs.ymlfile), which will build it into the
helpdirectory. You will then be good!
Repeat the command and MkDocs will clear out the old directory and rebuild it, so you can fold this into any update script.
To edit the
docs directory, you can run the live preview development server with:
Again in the base hydrus directory. It will host the help site at http://127.0.0.1:8000/, and when you change a file, it will automatically rebuild and reload the page in your browser.