Using Sphinx with Markdown to create documentation.
Uses MyST to add the Markdown functionality to Sphinx, replacing the RST syntax.
Mostly followed instructions in this course: Static Sites with Sphinx and Markdown (free at the time of this writing).
This project is intended to be used as reference to other projects on how to setup and use Sphinx with MyST.
Main features:
- Use MD syntax for documentation, which developers are usually more familiar with, instead of RST.
- Doc files are in the
/docs
folder. - Using
inv
(pyinvoke) instead ofmake
.
Seetasks.py
for more details on commands.