Comments on: Documentation and things… http://ramblings.timgolden.me.uk/2008/03/15/documentation-and-things/ The ramblings of Tim Golden Thu, 09 Feb 2012 09:28:31 +0000 http://wordpress.org/?v=2.2 By: Georg http://ramblings.timgolden.me.uk/2008/03/15/documentation-and-things/#comment-564 Georg Sun, 16 Mar 2008 11:29:51 +0000 http://ramblings.timgolden.me.uk/2008/03/15/documentation-and-things/#comment-564 Hey Tim, many thanks for the encouraging article! You're right, I've worked a lot on making Sphinx a standalone package, and I'm almost done. The most pressing need, viz. docs, has been addressed (look at the preview at http://sphinx.pocoo.org), and I shall be preparing a PyPI package soon. Hey Tim,

many thanks for the encouraging article! You’re right, I’ve worked a lot on making Sphinx a standalone package, and I’m almost done. The most pressing need, viz. docs, has been addressed (look at the preview at http://sphinx.pocoo.org), and I shall be preparing a PyPI package soon.

]]> By: tim http://ramblings.timgolden.me.uk/2008/03/15/documentation-and-things/#comment-563 tim Sun, 16 Mar 2008 11:07:40 +0000 http://ramblings.timgolden.me.uk/2008/03/15/documentation-and-things/#comment-563 Excellent. Thanks very much. Excellent. Thanks very much.

]]> By: Christopher Arndt http://ramblings.timgolden.me.uk/2008/03/15/documentation-and-things/#comment-562 Christopher Arndt Sun, 16 Mar 2008 10:14:44 +0000 http://ramblings.timgolden.me.uk/2008/03/15/documentation-and-things/#comment-562 It's very easy: - Checkout python-doctools from svn - Install Pygments - Copy "conf.py" into the directory where you keep your rest doc sources and adapt it - Write an "index.rst" with ".. toctree::" directives listing the source files in the order you want to have your sections. - Create the output directory - Run "shinx-build.py [-E] srcdir outdir". Look at "documenting/markup.rst" in a checkout of the Python documentation > 2.5. for documentation of the rest directives you can use. It’s very easy:

- Checkout python-doctools from svn
- Install Pygments
- Copy “conf.py” into the directory where you keep your
rest doc sources and adapt it
- Write an “index.rst” with “.. toctree::” directives
listing the source files in the order you want to
have your sections.
- Create the output directory
- Run “shinx-build.py [-E] srcdir outdir”.

Look at “documenting/markup.rst” in a checkout of the Python documentation > 2.5. for documentation of the rest directives you can use.

]]> By: tim http://ramblings.timgolden.me.uk/2008/03/15/documentation-and-things/#comment-561 tim Sun, 16 Mar 2008 06:47:03 +0000 http://ramblings.timgolden.me.uk/2008/03/15/documentation-and-things/#comment-561 @Christopher: exactly what I plan to do, myself. I know that Georg has put some work in lately separating out Sphinx-the-toolkit from Sphinx-the-Python-doc-machine. I haven't yet had time to figure out what I need to put where for my own docs. If you get there first, please do post. @Christopher: exactly what I plan to do, myself. I know that Georg has put some work in lately separating out Sphinx-the-toolkit from Sphinx-the-Python-doc-machine. I haven’t yet had time to figure out what I need to put where for my own docs. If you get there first, please do post.

]]> By: Christopher Arndt http://ramblings.timgolden.me.uk/2008/03/15/documentation-and-things/#comment-559 Christopher Arndt Sat, 15 Mar 2008 23:52:40 +0000 http://ramblings.timgolden.me.uk/2008/03/15/documentation-and-things/#comment-559 The docs produced by sphinx just look great! I think I am going to steal it for documenting my own projects! ;-) The docs produced by sphinx just look great! I think I am going to steal it for documenting my own projects! ;-)

]]>