summaryrefslogtreecommitdiff
path: root/doc/faq.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2009-05-13 09:15:29 +0200
committerGeorg Brandl <georg@python.org>2009-05-13 09:15:29 +0200
commitf0b4223e57ee61184fc0aa770219987cb44625f1 (patch)
tree3a3f649d5ebe17f00bbdfa2cb97651baa23ef1b4 /doc/faq.rst
parentf221194a3c25dd6bbb79314e54c36e317cfc0daf (diff)
downloadsphinx-f0b4223e57ee61184fc0aa770219987cb44625f1.tar.gz
Add more interop links.
Diffstat (limited to 'doc/faq.rst')
-rw-r--r--doc/faq.rst25
1 files changed, 19 insertions, 6 deletions
diff --git a/doc/faq.rst b/doc/faq.rst
index 10a6f2c4..a724ddca 100644
--- a/doc/faq.rst
+++ b/doc/faq.rst
@@ -22,18 +22,31 @@ How do I...
... write my own extension?
See the :ref:`extension tutorial <exttut>`.
-... use Sphinx with Epydoc?
+... 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.
-... use Sphinx with SCons?
+Doxygen
+ Michael Jones is developing a reST/Sphinx bridge to doxygen called `breathe
+ <http://github.com/michaeljones/breathe/tree/master>`_.
+
+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.
+github pages
+ You can use `Michael Jones' sphinx-to-github tool
+ <http://github.com/michaeljones/sphinx-to-github/tree/master>`_ to prepare
+ Sphinx HTML output.
.. _api role: http://git.savannah.gnu.org/cgit/kenozooid.git/tree/doc/extapi.py