mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Add more interop links.
This commit is contained in:
parent
b1dbe95255
commit
92f420bd22
29
doc/faq.rst
29
doc/faq.rst
@ -22,19 +22,32 @@ How do I...
|
|||||||
... write my own extension?
|
... write my own extension?
|
||||||
See the :ref:`extension tutorial <exttut>`.
|
See the :ref:`extension tutorial <exttut>`.
|
||||||
|
|
||||||
... 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?
|
... convert from my existing docs using MoinMoin markup?
|
||||||
The easiest way is to convert to xhtml, then convert `xhtml to reST`_. You'll
|
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
|
still need to mark up classes and such, but the headings and code examples
|
||||||
come through cleanly.
|
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
|
||||||
|
<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
|
||||||
|
|
||||||
|
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
|
.. _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
|
.. _xhtml to reST: http://docutils.sourceforge.net/sandbox/xhtml2rest/xhtml2rest.py
|
||||||
|
Loading…
Reference in New Issue
Block a user