[Python-checkins] r61706 - in doctools/trunk/doc: _templates/index.html builders.rst ext/builderapi.rst ext/coverage.rst ext/refcounting.rst

[georg.brandl]

Author: georg.brandl
Date: Fri Mar 21 19:59:28 2008
New Revision: 61706

Modified:
   doctools/trunk/doc/_templates/index.html
   doctools/trunk/doc/builders.rst
   doctools/trunk/doc/ext/builderapi.rst
   doctools/trunk/doc/ext/coverage.rst
   doctools/trunk/doc/ext/refcounting.rst
Log:
Add license and repository info to front page, add comments where sections need to be written.


Modified: doctools/trunk/doc/_templates/index.html
==============================================================================
--- doctools/trunk/doc/_templates/index.html	(original)
+++ doctools/trunk/doc/_templates/index.html	Fri Mar 21 19:59:28 2008
@@ -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 %}

Modified: doctools/trunk/doc/builders.rst
==============================================================================
--- doctools/trunk/doc/builders.rst	(original)
+++ doctools/trunk/doc/builders.rst	Fri Mar 21 19:59:28 2008
@@ -66,3 +66,8 @@
 
    Its name is ``linkcheck``.
 
+
+Built-in Sphinx extensions that offer more builders are:
+
+* :mod:`~sphinx.ext.doctest`
+* :mod:`~sphinx.ext.coverage`

Modified: doctools/trunk/doc/ext/builderapi.rst
==============================================================================
--- doctools/trunk/doc/ext/builderapi.rst	(original)
+++ doctools/trunk/doc/ext/builderapi.rst	Fri Mar 21 19:59:28 2008
@@ -1,6 +1,8 @@
 Writing new builders
 ====================
 
+XXX to be expanded.
+
 .. class:: sphinx.builder.Builder
 
    This is the base class for all builders.

Modified: doctools/trunk/doc/ext/coverage.rst
==============================================================================
--- doctools/trunk/doc/ext/coverage.rst	(original)
+++ doctools/trunk/doc/ext/coverage.rst	Fri Mar 21 19:59:28 2008
@@ -12,6 +12,7 @@
    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:

Modified: doctools/trunk/doc/ext/refcounting.rst
==============================================================================
--- doctools/trunk/doc/ext/refcounting.rst	(original)
+++ doctools/trunk/doc/ext/refcounting.rst	Fri Mar 21 19:59:28 2008
@@ -3,3 +3,5 @@
 
 .. module:: sphinx.ext.refcounting
    :synopsis: Keep track of reference counting behavior.
+
+XXX to be written.