【文档】使用Sphinx + reST编写文档

sudo apt-get install python-pip

sudo pip install -U Sphinx

sudo apt-get install doxygen

sudo pip install breathe

sudo apt-get install texlive-full

zzq@vmware:~/doc$ sphinx-quickstart

Welcome to the Sphinx 1.3. quickstart utility.

Please enter values for the following settings (just press Enter to

accept a default value, if one is given in brackets).

Enter the root path for documentation.

> Root path for the documentation [.]: 

You have two options for placing the build directory for Sphinx output.

Either, you use a directory "_build" within the root path, or you separate

"source" and "build" directories within the root path.

> Separate source and build directories (y/n) [n]: y

Inside the root directory, two more directories will be created; "_templates"

for custom HTML templates and "_static" for custom stylesheets and other static

files. You can enter another prefix (such as ".") to replace the underscore.

> Name prefix for templates and static dir [_]: 

The project name will occur in several places in the built documentation.

> Project name: foo

> Author name(s): zzq

Sphinx has the notion of a "version" and a "release" for the

software. Each version can have multiple releases. For example, for

Python the version is something like 2.5 or 3.0, while the release is

something like 2.5. or .0a1.  If you don't need this dual structure,

just set both to the same value.

> Project version: 1.0

> Project release [1.0]: 

If the documents are to be written in a language other than English,

you can select a language here by its language code. Sphinx will then

translate text that it generates into that language.

For a list of supported codes, see

http://sphinx-doc.org/config.html#confval-language.

> Project language [en]: 

The file name suffix for source files. Commonly, this is either ".txt"

or ".rst".  Only files with this suffix are considered documents.

> Source file suffix [.rst]: 

One document is special in that it is considered the top node of the

"contents tree", that is, it is the root of the hierarchical structure

of the documents. Normally, this is "index", but if your "index"

document is a custom template, you can also set this to another filename.

> Name of your master document (without suffix) [index]: 

Sphinx can also add configuration for epub output:

> Do you want to use the epub builder (y/n) [n]: 

Please indicate if you want to use one of the following Sphinx extensions:

> autodoc: automatically insert docstrings from modules (y/n) [n]:

> doctest: automatically test code snippets in doctest blocks (y/n) [n]:

> intersphinx: link between Sphinx documentation of different projects (y/n) [n]:

> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]:

> coverage: checks for documentation coverage (y/n) [n]:

> pngmath: include math, rendered as PNG images (y/n) [n]:

> mathjax: include math, rendered in the browser by MathJax (y/n) [n]:

> ifconfig: conditional inclusion of content based on config values (y/n) [n]:

> viewcode: include links to the source code of documented Python objects (y/n) [n]: 

A Makefile and a Windows command file can be generated for you so that you

only have to run e.g. `make html' instead of invoking sphinx-build

directly.

> Create Makefile? (y/n) [y]:

> Create Windows command file? (y/n) [y]: 

Creating file ./source/conf.py.

Creating file ./source/index.rst.

Creating file ./Makefile.

Creating file ./make.bat.

Finished: An initial directory structure has been created.

You should now populate your master file ./source/index.rst and create other documentation

source files. Use the Makefile to build the docs, like so:

   make builder

where "builder" is one of the supported builders, e.g. html, latex or linkcheck.

zzq@vmware:~/doc$ 

build  make.bat  Makefile  source

conf.py  index.rst  _static  _templates

intro

=====

sample

======

Welcome to foo's documentation!

===============================                                    

Contents:                                                          

.. toctree::

   :maxdepth:                                                     

   intro

   sample
               

zzq@vmware:~/doc/source$ cd ..

zzq@vmware:~/doc$ make html

sphinx-build -b html -d build/doctrees   source build/html

Running Sphinx v1.3.3

loading pickled environment... done

building [mo]: targets for  po files that are out of date

building [html]: targets for  source files that are out of date

updating environment:  added,  changed,  removed

reading sources... [%] sample

looking for now-outdated files... none found

pickling environment... done

checking consistency... done

preparing documents... done

writing output... [%] sample

generating indices... genindex

writing additional pages... search

copying static files... done

copying extra files... done

dumping search index in English (code: en) ... done

dumping object inventory... done

build succeeded.

Build finished. The HTML pages are in build/html.

# The theme to use for HTML and HTML Help pages.  See the documentation for

# a list of builtin themes.

html_theme = 'alabaster'

.. toctree::

    :maxdepth:

    :numbered:

    foo

    bar

breathe_projects = { "myproject": "./my_xml" }

breathe_default_project = "myproject"

breathe_domain_by_extension = {"h" : "c"}

html:

    doxygen Doxyfile

    $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

    @echo

    @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

latex_elements = {

# The paper size ('letterpaper' or 'a4paper').

#'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').

#'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.

'preamble': '''

\\hypersetup{unicode=true}

\\usepackage{CJKutf8}

\\AtBeginDocument{\\begin{CJK}{UTF8}{gbsn}}

\\AtEndDocument{\\end{CJK}}

''',

intro

=====                                                              

aaa

---

aaaaaaaaaaaa                                                       

bbbb

----

bbbbbbbbbbb

html_sidebars = { '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html']}

| aaaaaaaa

| bbbbbbbbb

| cccccccccccc 

aaaa **加粗** aaaaa                                                

aaaa *倾斜* aaaaa                                                  

aaaaa ``引用`` aaaaaa  

* item

* item

* item                                                          

. item1

. item2

. item3                                                        

#. item4

#. item5

#. item6                                                        

FOO

    this is very interesting.                                   

BAR

    this is interesting, too. 

source code below ::                                             

    void foo()

    {

        int i;                                                  

        for(i=; i<; i++)

            printf("i: %d\n", a);

    }                                                           

source code again                                               

.. code-block:: c

    :linenos:

    :emphasize-lines: ,                                       

    void foo()

    {

        int i;                                                  

        for(i=; i<; i++)

            printf("i: %d\n", a);

    }
                                     

visit `baidu <http://www.baidu.com>`_                           

visit `baidu URL`_                                              

.. _baidu URL: http://www.baidu.com   

baidu logo:                                                     

.. image:: ./images/bdlog.png

    :width: 200px 

simple table:                                                   

=====  =====  ======

   Inputs     Output

------------  ------

A      B      A or B

=====  =====  ======

False  False  False

True   False  True

False  True   True

True   True   True

=====  =====  ======                                            

grid table: 

+------------------------+------------+----------+----------+

| Header row, column    | Header    | Header  | Header  |

| (header rows optional) |            |          |          |

+========================+============+==========+==========+

| body row , column    | column    | column  | column  |

+------------------------+------------+----------+----------+

| body row              | Cells may span columns.          |

+------------------------+------------+---------------------+

| body row              | Cells may  | - Table cells       |

+------------------------+ span rows. | - contain           |

| body row              |            | - body elements.    |

+------------------------+------------+---------------------+ 

It is methioned by [Ref]_ that C++ is good.                     

.. [Ref] 《zzq's talk》

orem ipsum [#f1]_ dolor sit amet ... [#f2]_                    

Footnotes                                                       

.. [#f1] Text of the first footnote.

.. [#f2] Text of the second footnote.   

I like eat |apple| very much.                                   

.. |apple| replace:: 苹果  

I like eat 苹果 very much.