Skip to content

Instantly share code, notes, and snippets.

@SHDShim

SHDShim/sphinx_tutorial.md

Last active April 2, 2018 17:27
Show Gist options
  • Save SHDShim/55b900f59b21d8a1e432216bd04816fe to your computer and use it in GitHub Desktop.
Save SHDShim/55b900f59b21d8a1e432216bd04816fe to your computer and use it in GitHub Desktop.
Download ZIP
sphinx, python, github, manual
Raw
sphinx_tutorial.md

Short and easy tutorial for Sphinx

Sphinx is a powerful python tool to automatically generate manual html files for posting. However, it looks quite scary to use if you read regular tutorial. I found the tutorial linked below is really helpful for me to start. Just provide docstring, then sphinx will take care of it.

This works great: https://gisellezeno.com/tutorials/sphinx-for-python-documentation.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment