sphinx tutorial

sphinx_tutorial.md

Sphinx Notes

What is sphinx

Sphinx is used to document api-docs, the python docs also uses this.

Starter

Sphinx uses rst to write documents, but I've used markdown to write docs for a while, so it is nice to have know both.

Go to read my other gist here

Saving Time With APIdoc

Let's generate rst files for modules using

sphinx-apidoc [options] -o <outputdir> <sourcedir> [pathnames ...]

Must understand TOC(Table of contents) as well.

References

A ReStructuredText Primer

reStructuredText Primer

Sphinx official

Sphinx Autodoc Tutorial for Dummies

Pandoc Markdown and ReST Compared

Documenting Your Project Using Sphinx

SphinxTutorial Documentation

Sphinx as a Static Site Generator

Writing A Book With Vim, Restructured Text, and Sphinx