[Checkins] SVN: Sandbox/ulif/grok-reference-with-rest3/doc/ Add an 'about docs' section.

Uli Fouquet uli at gnufix.de
Sat Feb 23 17:22:46 EST 2008


Log message for revision 84204:
  Add an 'about docs' section.

Changed:
  A   Sandbox/ulif/grok-reference-with-rest3/doc/ACKS.txt
  A   Sandbox/ulif/grok-reference-with-rest3/doc/about_grokdoc.rst
  U   Sandbox/ulif/grok-reference-with-rest3/doc/build/docindex.template
  U   Sandbox/ulif/grok-reference-with-rest3/doc/index.rst

-=-
Added: Sandbox/ulif/grok-reference-with-rest3/doc/ACKS.txt
===================================================================
--- Sandbox/ulif/grok-reference-with-rest3/doc/ACKS.txt	                        (rev 0)
+++ Sandbox/ulif/grok-reference-with-rest3/doc/ACKS.txt	2008-02-23 22:22:46 UTC (rev 84204)
@@ -0,0 +1,23 @@
+Contributors to the Grok Documentation
+--------------------------------------
+
+This section lists people who have contributed in some way to the Grok
+documentation. It is probably not complete -- if you feel that you or
+anyone else should be on this list, please let us know (send email to
+grok-dev at zope.org), and we'll be glad to correct the problem.
+
+.. acks::
+
+   * Darryl Cousins
+   * Kushal Das
+   * Martijn Faassen
+   * Uli Fouquet
+   * Jim Fulton
+   * Jan-Wijbrand Kolman
+   * Luis de la Parra
+   * Luciano Ramalho
+   * Lennart Regebro
+   * Brandon Craig Rhodes
+   * Kevin Teague
+   * Sebastian Ware
+   * Philipp von Weitershausen

Added: Sandbox/ulif/grok-reference-with-rest3/doc/about_grokdoc.rst
===================================================================
--- Sandbox/ulif/grok-reference-with-rest3/doc/about_grokdoc.rst	                        (rev 0)
+++ Sandbox/ulif/grok-reference-with-rest3/doc/about_grokdoc.rst	2008-02-23 22:22:46 UTC (rev 84204)
@@ -0,0 +1,30 @@
+=====================
+About these documents
+=====================
+
+
+These documents are generated from `reStructuredText
+<http://docutils.sf.net/rst.html>`_ sources by *Sphinx*, an excellent
+document processor specifically written for the Python documentation
+by Georg Brandl and contributors.
+
+In the online version of these documents, you can submit comments and suggest
+changes directly on the documentation pages.
+
+Development of this documentation and its toolchain takes place on the
+grok-dev at zope.org mailing list.  We're always looking for volunteers
+wanting to help with the docs, so feel free to send a mail there!
+
+Many thanks go to:
+
+* the `docutils <http://docutils.sf.net/>`_ project for creating
+  reStructuredText and the docutils suite;
+* Georg Brandl for his `sphinx` package.
+
+See :ref:`reporting-bugs` for information how to report bugs in Python itself.
+
+.. including the ACKS file here so that it can be maintained separately
+.. include:: ACKS.txt
+
+It is only with the input and contributions of the Grok community
+that Grok has so much documentation -- Thank You!
\ No newline at end of file

Modified: Sandbox/ulif/grok-reference-with-rest3/doc/build/docindex.template
===================================================================
--- Sandbox/ulif/grok-reference-with-rest3/doc/build/docindex.template	2008-02-23 22:04:09 UTC (rev 84203)
+++ Sandbox/ulif/grok-reference-with-rest3/doc/build/docindex.template	2008-02-23 22:22:46 UTC (rev 84204)
@@ -50,6 +50,9 @@
       <p class="biglink"><a class="biglink" href="{{ pathto("bugs") }}"
       >Reporting bugs</a><br>
 
+      <p class="biglink"><a class="biglink" href="{{ pathto("about_grokdoc") }}"
+      >About the documentation</a><br>
+
     </td><td width="50%">
 
       <p class="biglink"><a class="biglink" href="{{ pathto("license") }}"

Modified: Sandbox/ulif/grok-reference-with-rest3/doc/index.rst
===================================================================
--- Sandbox/ulif/grok-reference-with-rest3/doc/index.rst	2008-02-23 22:04:09 UTC (rev 84203)
+++ Sandbox/ulif/grok-reference-with-rest3/doc/index.rst	2008-02-23 22:22:46 UTC (rev 84204)
@@ -181,5 +181,6 @@
    reference/index.rst
 
    bugs.rst
+   about_grokdoc.rst
    license.rst
    copyright.rst
\ No newline at end of file



More information about the Checkins mailing list