IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add FAQ, to be expanded.

Browse Source
This commit is contained in:
Georg Brandl
2009-02-12 12:50:42 +01:00
parent 36b21d0570
commit 5e1448361f
2 changed files with 22 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/contents.rst
View File

@@ -14,7 +14,8 @@ Sphinx documentation contents
config
templating
extensions
faq
glossary
changes
examples

20
doc/faq.rst Normal file
View File

@@ -0,0 +1,20 @@
.. _faq:
Sphinx FAQ
==========
This is a list of Frequently Asked Questions about Sphinx. Feel free to
suggest new entries!
How do I...
-----------
... add global substitutions?
Add them in the :confval:`rst_epilog` config value.
... 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.
.. _api role: http://git.savannah.gnu.org/cgit/kenozooid.git/tree/doc/extapi.py