posts/Sphinx.mdwn

   1 [Sphinx][] is a publishing tool that is generally used for [[Python]]
   2 documentation, although it can be used for other documents as well.
   3 Sphinx is primarily based on [reStructuredText][rst], and there are
   4 all sorts of [useful extensions][ext] (e.g. [intersphinx][],
   5 [pngmath][], ...).  There is a good [tutorial][] in the
   6 [documentation][].
   7
   8 If you're writing a lot of Python, you should probably consider the
   9 [numpydoc][] package, which tries to [strike a balance][balance]
  10 between full markup for Sphinx publishing and raw readability.
  11
  12 [Sphinx]: http://sphinx.pocoo.org/
  13 [rst]: http://docutils.sf.net/rst.html
  14 [ext]: http://sphinx.pocoo.org/latest/extensions.html#builtin-sphinx-extensions
  15 [intersphinx]: http://sphinx.pocoo.org/latest/ext/intersphinx.html
  16 [pngmath]: http://sphinx.pocoo.org/latest/ext/math.html#module-sphinx.ext.pngmath
  17 [tutorial]: http://sphinx.pocoo.org/latest/tutorial.html
  18 [documentation]: http://sphinx.pocoo.org/latest/contents.html
  19 [numpydoc]: http://pypi.python.org/pypi/numpydoc/
  20 [balance]: http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
  21
  22 [[!tag tags/tools]]
  23 [[!tag tags/programming]]
  24 [[!tag tags/python]]