From: W. Trevor King <wking@drexel.edu>
Date: Wed, 6 Oct 2010 18:59:58 +0000 (-0400)
Subject: Added Sphinx post.
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=12564d715440d1b642cf01a745fe5e0aeb46736f;p=blog.git

Added Sphinx post.
---

diff --git a/posts/Sphinx.mdwn b/posts/Sphinx.mdwn
new file mode 100644
index 0000000..0b0b7bb
--- /dev/null
+++ b/posts/Sphinx.mdwn
@@ -0,0 +1,20 @@
+[Sphinx][] is a publishing tool that is generally used for [[Python]]
+documentation, although it can be used for other documents as well.
+Sphinx is primarily based on [reStructuredText][rst], and there are
+all sorts of [useful extensions][ext] (e.g. [intersphinx][],
+[pngmath][], ...).  There is a good [tutorial][] in the
+[documentation][].
+
+If you're writing a lot of Python, you should probably consider the
+[numpydoc][] package, which tries to [strike a balance][balance]
+between full markup for Sphinx publishing and raw readability.
+
+[Sphinx]: http://sphinx.pocoo.org/
+[rst]: http://docutils.sf.net/rst.html
+[ext]: http://sphinx.pocoo.org/latest/extensions.html#builtin-sphinx-extensions
+[intersphinx]: http://sphinx.pocoo.org/latest/ext/intersphinx.html
+[pngmath]: http://sphinx.pocoo.org/latest/ext/math.html#module-sphinx.ext.pngmath
+[tutorial]: http://sphinx.pocoo.org/latest/tutorial.html
+[documentation]: http://sphinx.pocoo.org/latest/contents.html
+[numpydoc]: http://pypi.python.org/pypi/numpydoc/
+[balance]: http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines