Documentation
Ezored come with documentation generator separated by folder.
Each folder come with files compatible with mkdocs tool with mkdocs-material theme.
Inside folder files/docs you can create how many documentations do you need.
Test locally
While you write your documentation, you can see it in your browser with the command:
python make.py docs serve --name=default
Obs: Open in your borwser: http://127.0.0.1:8000
Parameters
- --name: The folder name and configuration name
- --force: Overwrite documentation already published
Configurations
All documentation settings need be inside file files/config/docs.py.
Obs: The configuration append_version will append version to folder where documentation is stored.