Sphinx文档生成工具与readthedocs.org

Sphinx是一个python写的文档编辑工具，简洁的语法，并且很方便使用。readthedocs.org是一个网站，可以导入Sphinx文档，并且可以与git, bazzar等代码库关联自动生成文档。

http://sphinx.pocoo.org/

http://readthedocs.org/  or http://rtfd.org

readthedocs.org文档

http://readthedocs.org/docs/read-the-docs/en/latest/

TODO的用法

曾有一个错误是todo没有被定义:

add-doc/doc/usage.rst:63: (ERROR/3) Unknown directive type "todo".

.. todo::

这必须在conf.py中加入一个扩展sphinx.ext.todo才能搞定，并且把todo_include_todos设为True。

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.doctest',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.viewcode']

# Configuration for sphinx.ext.todo

todo_include_todos = True

用一个todolist可以把所有todo都轻松归纳到一个页面上：

List of items that need work
============================

.. todolist::

todo标签在文档中的使用方法：

.. todo::

    Describe how to collect enough information to debug dispatcher when the job execution failed.

readthedocs.org与bazaar代码仓库的关联

在repo中填lp:xxx，在Default branch中不要填branch，只能使用默认的truck，这个是git与mercurial专用的。这就意味着bazaar的code必须upload到master branch后网站才会更新文档。

readthedocs.org如何更新文档

Readthedocs用sphinx去生成文档. 代码仓库的根目录下的setup.py必须有一个名为build_sphinx的standardized entry point. 这样readthedocs可以通过./setup.py build_sphinx去编译文档，这样就可以删除用sphinx quick-start命令生成的Makefile, 如果有这个Makefile可以使用build html来生成文档。

sphinx所需要的配置在doc/conf.py或docs/conf.py:

# -*- coding: utf-8 -*-
#
# LAVA Dispatcher documentation build configuration file, created by
# sphinx-quickstart on Sat Sep 24 18:20:56 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, os

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.append(os.path.abspath('..'))

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
        'sphinx.ext.autodoc',
        'sphinx.ext.doctest',
        'sphinx.ext.intersphinx',
        'sphinx.ext.todo',
        'sphinx.ext.coverage',
        'sphinx.ext.viewcode']

# Configuration for sphinx.ext.todo

todo_include_todos = True

# Add any paths that contain templates here, relative to this directory.
templates_path = []

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'LAVA Dispatcher'
copyright = u'2011, Linaro Validation Team'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.3'
# The full version, including alpha/beta/rc tags.
release = '0.3'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []


# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = 'default'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True

# If false, no index is generated.
#html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'LAVADispatcherDoc'


# -- Options for LaTeX output --------------------------------------------------

# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'

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

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
  ('index', 'LAVADispatcher.tex', u'LAVA Dispatcher Documentation',
   u'Linaro Validation Team', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Additional stuff for the LaTeX preamble.
#latex_preamble = ''

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'lavadispatcher', u'LAVA Dispatcher Documentation',
     [u'Linaro Validation Team'], 1)
]

Grammar

Include a source code file:

.. literalinclude:: ../../linaro_dashboard_bundle/schemas/dashboard_bundle_format_1.3.json
    :language: javascript
    :linenos:

auto document

When autodoc plugin is enabled, the simplest way is to use:

.. automodule:: noodle
   :members:

:members: 会直接把该module所有有docstring注释的class和method都自动归纳。这里有几个限制：

1. 如果method有docstring而class没有，则不会自动生成。

2. 其他限制规则如下：

For module data members and class attributes, documentation can either be putinto a special-formatted comment, or in a docstring after the definition.Comments need to be either on a line of their own before the definition, or immediately after the assignment on the same line. The latter form isrestricted to one line only.

在member和method, 注释要放在紧挨着它们声明的后面，可以多行，对member注释可以放在它赋值的前一行或者同一行，后者只能为一行。

http://packages.python.org/an_example_pypi_project/sphinx.html
http://sphinx.pocoo.org/ext/autodoc.html

编写Hooks

文档会做nightly build，但如果你想实时更新，则需要设置hooks: http://wiki.bazaar.canonical.com/BzrHooks