diff --git a/doc/_templates/index.html b/doc/_templates/index.html
index a68a62514..082a1f878 100644
--- a/doc/_templates/index.html
+++ b/doc/_templates/index.html
@@ -4,7 +4,7 @@
Welcome
-
What users say:
+
What users say:
“Cheers for a great tool that actually makes programmers want
to write documentation!”
Sphinx is a tool that makes it easy to create intelligent and beautiful
documentation, written by Georg Brandl and licensed under the BSD license.
- It was originally created to translate the
- new Python documentation, and it has excellent support for the documentation
- of Python projects, but other documents can be written with it too. Of course,
- this site is also created from reStructuredText sources using Sphinx!
+
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!
- It is still under constant development, and the following features are
- already present, work fine and can be seen “in action” in the
- Python docs:
+ Sphinx is under constant development. The following features are present,
+ work fine and can be seen “in action” in the Python docs:
- - Output formats: HTML (including Windows HTML Help) and LaTeX, for
- printable PDF versions
+ - Output formats: HTML (including Windows HTML Help), LaTeX (for
+ printable PDF versions), manual pages, plain text
- Extensive cross-references: semantic markup and automatic links
- for functions, classes, glossary terms and similar pieces of information
+ 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 links to siblings, parents and children
- Automatic indices: general index as well as a module index
- Code handling: automatic highlighting using the Pygments highlighter
+ href="http://pygments.org">Pygments highlighter
- Extensions: automatic testing of code snippets, inclusion of
- docstrings from Python modules, and more
+ docstrings from Python modules (API docs), and more
Sphinx uses reStructuredText
@@ -42,39 +44,40 @@
suite, the Docutils.
- Examples
-
- The Python documentation and
- this page are different examples of Sphinx in use.
- You can also download PDF versions of the Sphinx documentation:
- a version generated from
- the LaTeX Sphinx produces, and a
- version generated by rst2pdf.
-
-
- For examples of how Sphinx source files look, use the “Show source”
- links on all pages of the documentation apart from this welcome page.
-
- Links to more documentation generated with Sphinx can be found on the
- Projects using Sphinx page.
-
-
Documentation
|
+ First steps with Sphinx
+ overview of basic tasks
Contents
for a complete overview
+ |
Search page
search the documentation
- |
General Index
all functions, classes, terms
- Module Index
- quick access to all documented modules
|
+
+ 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
diff --git a/doc/intro.rst b/doc/intro.rst
index d72cf360a..585d04f01 100644
--- a/doc/intro.rst
+++ b/doc/intro.rst
@@ -11,9 +11,9 @@ browsing and navigation. But from the same source, it can also generate a
LaTeX file that you can compile into a PDF version of the documents.
The focus is on hand-written documentation, rather than auto-generated API docs.
-Though there is limited support for that kind of docs as well (which is intended
-to be freely mixed with hand-written content), if you need pure API docs have a
-look at `Epydoc `_, which also understands reST.
+Though there is support for that kind of docs as well (which is intended to be
+freely mixed with hand-written content), if you need pure API docs have a look
+at `Epydoc `_, which also understands reST.
Conversion from other systems
diff --git a/setup.py b/setup.py
index 6a46e6d61..b2c96f48e 100644
--- a/setup.py
+++ b/setup.py
@@ -11,20 +11,21 @@ import sphinx
long_desc = '''
Sphinx is a tool that makes it easy to create intelligent and beautiful
-documentation for Python projects (or other documents consisting of
-multiple reStructuredText sources), written by Georg Brandl.
-It was originally created to translate the new Python documentation,
-but has now been cleaned up in the hope that it will be useful to many
-other projects.
+documentation for Python projects (or other documents consisting of multiple
+reStructuredText sources), written by Georg Brandl. It was originally created
+for the new Python documentation, and has excellent facilities for Python
+project documentation, but C/C++ is supported as well, and more languages are
+planned.
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.
+come from the power and straightforwardness of reStructuredText and its parsing
+and translating suite, the Docutils.
Among its features are the following:
* Output formats: HTML (including derivative formats such as HTML Help, Epub
- and Qt Help), plain text and LaTeX or direct PDF output using rst2pdf
+ and Qt Help), plain text, manual pages and LaTeX or direct PDF output
+ using rst2pdf
* Extensive cross-references: semantic markup and automatic links
for functions, classes, glossary terms and similar pieces of information
* Hierarchical structure: easy definition of a document tree, with automatic