Sphinx can be used to create general documentation, not just for Python modules. It supports reStructuredText (reST) and Markdown, making it a versatile tool for documentation.
This repo is a playground / reference for creating documentation with Sphinx.
Install pandoc
via Homebrew if you haven't done so already:
brew install pandoc
pip3 install -r requirements.txt
If a Sphinx project hasn't been initialized, run the command:
sphinx-quickstart
sphinx-build -b html . _build
make clean
sphinx-build -b html . _build
Open the index.html
file located in the _build
directory.