Follow these steps.
cd docs
pip install -r requirements.txt
make html
- open
docs/_build/index.html
To make changes, edit the markdown files.
If you have done a major refactor (renaming files or directory structures),
you can use make clean html
to create a fresh build directory for local testing.
Also check out
If you want to contribute your expertise to this documentation, the best place to start would be to create a new issue and describe the content you plan on adding. This will allow other contributors to discuss with you and is a good way to check if someone else is already working on a similar idea that you can collaborate on.
Thanks goes to these wonderful people (emoji key):
isabelbacellar 🤔 👀 |
Gabriel A. Devenyi 🤔 🖋 📖 📆 |
Sebastian Urchs 🤔 🖋 📖 📆 |
Jeremie Fouquet 🖋 📖 |
LuceroGG 📓 🤔 |
Swapna 📓 🐛 🤔 |
raihaan 🤔 |
This project follows the all-contributors specification. Contributions of any kind welcome!