Home Get it Docs Extend/Develop Sphinx home …
[Pages:508]Home Get it Docs Extend/Develop
Sphinx home | Documentation ?
modules | index
Welcome
Sphinx is a tool that makes it easy What users say:
to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.
"Cheers for a great tool that actually makes programmers want to write documentation!"
It was originally created for the new
Python documentation, and it has excellent facilities for the
documentation of Python projects, but C/C++ is already supported
as well, and it is planned to add special support for other languages
as well. Of course, this site is also created from reStructuredText
sources using Sphinx! The following features should be highlighted:
Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), Texinfo, manual pages, plain text Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children Automatic indices: general index as well as a languagespecific module indices Code handling: automatic highlighting using the Pygments highlighter Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs), and more
Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
Documentation
First steps with
Search page
Sphinx overview of basic tasks search the documentation
Contents
for a complete overview
General Index
all functions, classes, terms
You can also download PDF versions of the Sphinx documentation: a version generated from the LaTeX Sphinx produces, and a version generated by rst2pdf.
Examples
Links to documentation generated with Sphinx can be found on the Projects using Sphinx page.
For examples of how Sphinx source files look, use the "Show source" links on all pages of the documentation apart from this welcome page.
You may also be interested in the very nice tutorial on how to create a customized documentation using Sphinx written by the matplotlib developers.
There is a Japanese translation of this documentation, thanks to the Japanese Sphinx user group.
A Japanese book about Sphinx has been published by O'Reilly:
Sphinx /
Learning Sphinx:
Sphinx home | Documentation ?
modules | index
? Copyright 2007-2013, Georg Brandl. Created using Sphinx 1.2.
Home Get it Docs Extend/Develop
Sphinx home | Documentation ?
modules | index
Python Module Index
a | b | c | d | e
a sphinx.application
b sphinx.builders
sphinx.builders.changes sphinx.builders.devhelp sphinx.builders.epub sphinx.builders.gettext sphinx.builders.html sphinx.builders.htmlhelp sphinx.builders.latex sphinx.builders.linkcheck sphinx.builders.manpage sphinx.builders.qthelp sphinx.builders.texinfo sphinx.builders.text sphinx.builders.xml
c conf
Application class and extensibility interface. Available built-in builder classes.
Build configuration
file.
d sphinx.domains
e sphinx.ext
sphinx.ext.autodoc sphinx.ext.autosummary sphinx.ext.coverage
sphinx.ext.doctest sphinx.ext.extlinks
sphinx.ext.graphviz sphinx.ext.ifconfig
sphinx.ext.inheritance_diagram sphinx.ext.intersphinx
Include documentation from docstrings.
Generate autodoc summaries
Check Python modules and C API for coverage in the documentation.
Test snippets in the documentation.
Allow inserting external links with common base URLs easily.
Support for Graphviz graphs.
Include documentation content based on configuration values.
Support for displaying inheritance diagrams via graphviz.
Link to other Sphinx documentation.
sphinx.ext.jsmath sphinx.ext.linkcode sphinx.ext.mathbase sphinx.ext.mathjax sphinx.ext.oldcmarkup sphinx.ext.pngmath sphinx.ext.todo sphinx.ext.viewcode
Render math using JavaScript via JSMath.
Add external links to source code.
Common math support for pngmath and mathjax / jsmath.
Render math using JavaScript via MathJax.
Allow further use of the pre-domain C markup
Render math as PNG images.
Allow inserting todo items into documents.
Add links to a highlighted version of the source code.
Sphinx home | Documentation ?
modules | index
? Copyright 2007-2013, Georg Brandl. Created using Sphinx 1.2.
................
................
In order to avoid copyright disputes, this page is only a partial summary.
To fulfill the demand for quickly locating and searching documents.
It is intelligent file search solution for home and business.