-
什么是sphinx?
- http://sphinx.pocoo.org/#
- Sphinx 用python实现,将reStruct源文件,转换成html,pdf,man,...文档。
-
概要介绍
- sphinx-quickstart演示
-
Directory Structure
-
conf.py
- 几个重要配置项
- index.rst
- _template
- _static
- _ext
-
Sphinx Concept
-
.. toctree::
- :numbered:
- :maxdepth:
- :glob:
- :hidden:
-
Special names
- genindex
- modindex
- search
-
reStructuredText Primer
-
Inline markup
- one asterisk: *text* for emphasis (italics)
- two asterisks: **text** for strong emphasis (boldface)
- backquotes: ``text`` for code samples
-
Lists and Quotes
- *
- number
- #
-
Hyperlinks
- `Link text <http://target>`
-
Sections
- # with overline, for parts
- * with overline, for chapters
- =, for sections
- -, for subsections
- ^, for subsubsections
- ", for paragraphs
-
Explicit Markup .. (“Explicit markup” is used in reST for most constructs that need special handling)
Directives (extension mechanisms of reST)
- Topic
- .. function:: foo(x)
- .. image:: gnu.png
- Footnotes
- :mod:`parrot` -- Dead parrot access
- .. code-block:: c
-
Django Sphinx Document 实例
- _static
- _template
- _ext
- conf.py