2009-02-12 05:50:42 -06:00
|
|
|
.. _faq:
|
|
|
|
|
|
|
|
|
|
Sphinx FAQ
|
|
|
|
|
==========
|
|
|
|
|
|
|
|
|
|
This is a list of Frequently Asked Questions about Sphinx. Feel free to
|
|
|
|
|
suggest new entries!
|
|
|
|
|
|
|
|
|
|
How do I...
|
|
|
|
|
-----------
|
|
|
|
|
|
2009-02-22 08:22:23 -06:00
|
|
|
... get section numbers?
|
|
|
|
|
They are automatic in LaTeX output; for HTML, give a ``:numbered:`` option to
|
|
|
|
|
the :dir:`toctree` directive where you want to start numbering.
|
|
|
|
|
|
2009-02-17 17:10:32 -06:00
|
|
|
... customize the look of the built HTML files?
|
|
|
|
|
Use themes, see :doc:`theming`.
|
|
|
|
|
|
2009-02-22 08:22:23 -06:00
|
|
|
... add global substitutions or includes?
|
2009-02-12 05:50:42 -06:00
|
|
|
Add them in the :confval:`rst_epilog` config value.
|
|
|
|
|
|
2009-02-17 17:10:32 -06:00
|
|
|
... write my own extension?
|
|
|
|
|
See the :ref:`extension tutorial <exttut>`.
|
2009-02-19 16:31:34 -06:00
|
|
|
|
2009-02-12 05:50:42 -06:00
|
|
|
... 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.
|
|
|
|
|
|
2009-03-15 17:43:09 -05:00
|
|
|
... 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
|
|
|
|
|
|
2009-02-12 05:50:42 -06:00
|
|
|
|
|
|
|
|
.. _api role: http://git.savannah.gnu.org/cgit/kenozooid.git/tree/doc/extapi.py
|
