1. Georg Brandl
  2. sphinx


georg.brandl  committed 4fa041e

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

  • Participants
  • Parent commits 6e170b5
  • Branches default

Comments (0)

Files changed (5)

File doc/_templates/index.html

View file
     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!)
     Although it is still under constant development, the following features are
     <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>
     Sphinx uses <a href="http://docutils.sf.net/rst.html">reStructuredText</a>
     package on the <a href="http://pypi.python.org/pypi/Sphinx">Python Package
+  <p>The code can be found on the Python SVN server, under
+    <tt>http://svn.python.org/projects/doctools</tt>.</p>
 {% endblock %}

File doc/builders.rst

View file
    Its name is ``linkcheck``.
+Built-in Sphinx extensions that offer more builders are:
+* :mod:`~sphinx.ext.doctest`
+* :mod:`~sphinx.ext.coverage`

File doc/ext/builderapi.rst

View file
 Writing new builders
+XXX to be expanded.
 .. class:: sphinx.builder.Builder
    This is the base class for all builders.

File doc/ext/coverage.rst

View file
    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:

File doc/ext/refcounting.rst

View file
 .. module:: sphinx.ext.refcounting
    :synopsis: Keep track of reference counting behavior.
+XXX to be written.