Skip to content

Instantly share code, notes, and snippets.

@j6k4m8

j6k4m8/Python Sphinx Auto-Documentation.md

Created January 24, 2016 20:16
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save j6k4m8/9ac8d150508a611b5303 to your computer and use it in GitHub Desktop.
Save j6k4m8/9ac8d150508a611b5303 to your computer and use it in GitHub Desktop.
Download ZIP
My method for autodoc'ing my code consistently each time.
Raw
Python Sphinx Auto-Documentation.md

How to Build Docs

The B directory (your usual working directory for development) should have a sister directory A at the same level, which is checked out to the gh-pages branch.

# from B directory:
sphinx-apidoc -o ../ndio-docs ./ndio/
cd docs
make html

 ..
 ╠═ repo (gh-pages)                             A
 ║
 ╠═ repo (master)                               B
 ║  ╠═ docs                                     C
 ║  ║    ╠═ build
 ║  ║    ╠═ source
 ║  ║    ╠═ Makefile
 ║  ║
 ║  ╠═ your code...                             D
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment