Add license and repository info to front page, add comments where sections need to be written.

This commit is contained in:
Georg Brandl 2008-03-21 18:59:28 +00:00
parent 0fc710ed8c
commit 49be523051
5 changed files with 17 additions and 3 deletions

View File

@ -10,12 +10,12 @@
<p>
Sphinx is a tool that makes it easy to create intelligent and beautiful
documentation for Python projects, written by Georg Brandl. It was
originally created to translate <a href="http://docs.python.org/dev/">the
documentation for Python projects, written by Georg Brandl and licensed
under the BSD license.</p>
<p>It was originally created to translate <a href="http://docs.python.org/dev/">the
new Python documentation</a>, but has now been cleaned up in the hope that
it will be useful to many other projects. (Of course, this site is also
created from reStructuredText sources using Sphinx!)
</p>
<p>
Although it is still under constant development, the following features are
@ -32,6 +32,8 @@
<li><b>Automatic indices:</b> general index as well as a module index</li>
<li><b>Code handling:</b> automatic highlighting using the <a
href="http://pygments.org">Pygments</a> highlighter</li>
<li><b>Extensions:</b> automatic testing of code snippets, inclusion of
docstrings from Python modules, and more</li>
</ul>
<p>
Sphinx uses <a href="http://docutils.sf.net/rst.html">reStructuredText</a>
@ -62,5 +64,7 @@
package on the <a href="http://pypi.python.org/pypi/Sphinx">Python Package
Index</a>.
</p>
<p>The code can be found on the Python SVN server, under
<tt>http://svn.python.org/projects/doctools</tt>.</p>
{% endblock %}

View File

@ -66,3 +66,8 @@ The builder's "name" must be given to the **-b** command-line option of
Its name is ``linkcheck``.
Built-in Sphinx extensions that offer more builders are:
* :mod:`~sphinx.ext.doctest`
* :mod:`~sphinx.ext.coverage`

View File

@ -1,6 +1,8 @@
Writing new builders
====================
XXX to be expanded.
.. class:: sphinx.builder.Builder
This is the base class for all builders.

View File

@ -12,6 +12,7 @@ This extension features one additional builder, the :class:`CoverageBuilder`.
To use this builder, activate the coverage extension in your configuration
file and give ``-b coverage`` on the command line.
XXX to be expanded.
Several new configuration values can be used to specify what the builder
should check:

View File

@ -3,3 +3,5 @@
.. module:: sphinx.ext.refcounting
:synopsis: Keep track of reference counting behavior.
XXX to be written.