From 92f420bd22f9cc91a877f4fc6f8bca73e583bdd7 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Wed, 13 May 2009 09:15:29 +0200 Subject: [PATCH] Add more interop links. --- doc/faq.rst | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/doc/faq.rst b/doc/faq.rst index 10a6f2c48..a724ddcaf 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -22,19 +22,32 @@ How do I... ... write my own extension? See the :ref:`extension tutorial `. -... use Sphinx with Epydoc? - There's a third-party extension providing an `api role`_ which refers to - Epydoc's API docs for a given identifier. - -... use Sphinx with SCons? - Glenn Hutchings has written a SCons build script to build Sphinx - documentation; it is hosted here: http://bitbucket.org/zondo/sphinx-scons - ... convert from my existing docs using MoinMoin markup? The easiest way is to convert to xhtml, then convert `xhtml to reST`_. You'll still need to mark up classes and such, but the headings and code examples come through cleanly. +Using Sphinx with... +-------------------- + +Epydoc + There's a third-party extension providing an `api role`_ which refers to + Epydoc's API docs for a given identifier. + +Doxygen + Michael Jones is developing a reST/Sphinx bridge to doxygen called `breathe + `_. + +SCons + Glenn Hutchings has written a SCons build script to build Sphinx + documentation; it is hosted here: http://bitbucket.org/zondo/sphinx-scons + +github pages + You can use `Michael Jones' sphinx-to-github tool + `_ to prepare + Sphinx HTML output. + + .. _api role: http://git.savannah.gnu.org/cgit/kenozooid.git/tree/doc/extapi.py .. _xhtml to reST: http://docutils.sourceforge.net/sandbox/xhtml2rest/xhtml2rest.py