docs.md

Auto Docs Python

How to auto make docs with docstrings in python using Sphinx

Docstrings

Explanations on docstrings - vide pep 257

Python Docstrings - Programiz

Docstrings in Python Tutorial - Datacamp

Auto generate docstrings on python with extension on vscode:

VSCode docstrings extension - Marketplace

Sphinx

Sphinx docs

Sphinx quick setup - TowardsDataScience

Additional

Problems?

See this also util stack

GhPages

To push to ghpages and avoid jekyll problem Echorand.me

Remember:

if __name__ == "__main__":
    main()

Put it on the main file so it doesn't run your code on make html, because of the imports