Install PyReverse (part of pylint), and Graphviz for automatic class diagram creation
conda activate pipeline
conda install -c conda-forge pylint python-graphviz
# change directory into the pipeline/pacakge directory then run the following commands
mkdir docs/images
pyreverse src/ampl -p AMPL -d docs/images -o pngTo run Sphinx on the project to create the documentation
Quickstart creates Sphinx folder structure and required files
sphinx-apidoc -o docs src/ampl
cd docs
make htmlExample installing a theme
pip install cloud_sptheme
To use the them modify conf.py to use the cloud theme
html_theme = 'cloud'
If you need to create a sphinx document folder then run the following command
cd ampl
sphinx-quickstart docs
For viewing the sphinx documentation, navigate to within the docs folder of the project.
On windows run the following command
start _build/html/index.html
On mac/Linux run the following command
open _build/html/index.html
A quickstart guide on how to set and and run sphinx from scratch can be found here https://eikonomega.medium.com/getting-started-with-sphinx-autodoc-part-1-2cebbbca5365
Sphinx themes - a gallery of available themes https://sphinx-themes.org/
Git repo references
https://github.com/matiassingers/awesome-readme
https://github.com/amitmerchant1990/electron-markdownify#readme
https://github.com/anfederico/Clairvoyant#readme
Quick references for markdown
https://www.markdownguide.org/basic-syntax/
https://markdown-it.github.io/
https://docs.gitlab.com/ee/user/markdown.html#table-of-contents