Merged revisions 80388 via svnmerge from

svn+ssh://pythondev@svn.python.org/python/trunk

........
  r80388 | georg.brandl | 2010-04-23 00:15:33 +0200 (Fr, 23 Apr 2010) | 1 line

  Add "report a bug" links in some prominent places.  Make it clear that doc bugs can be mailed to docs@python.org.  Clarify tracker usage.
........

diff --git a/Doc/about.rst b/Doc/about.rst
index 9483ca5347c84d30444b90ea73e46384375b44c3..2c229e662c42de13cf4ddc24f7c895a3ebddc324 100644 (file)
--- a/Doc/about.rst
+++ b/Doc/about.rst
@@ -3,9 +3,11 @@ About these documents
 =====================
 
 
-These documents are generated from `reStructuredText
-<http://docutils.sf.net/rst.html>`_ sources by *Sphinx*, a document processor
-specifically written for the Python documentation.
+These documents are generated from `reStructuredText`_ sources by `Sphinx`_, a
+document processor specifically written for the Python documentation.
+
+.. _reStructuredText: http://docutils.sf.net/rst.html
+.. _Sphinx: http://sphinx.pocoo.org/
 
 .. In the online version of these documents, you can submit comments and suggest
    changes directly on the documentation pages.

diff --git a/Doc/bugs.rst b/Doc/bugs.rst
index 4db2433a1d6685430c06dc49b6db828a156fa99e..a9a48c7858f69b3c7ae904d9327ed9defffabbf9 100644 (file)
--- a/Doc/bugs.rst
+++ b/Doc/bugs.rst
@@ -1,14 +1,32 @@
 .. _reporting-bugs:
 
-************************
-Reporting Bugs in Python
-************************
+**************
+Reporting Bugs
+**************
 
 Python is a mature programming language which has established a reputation for
 stability.  In order to maintain this reputation, the developers would like to
 know of any deficiencies you find in Python.
 
-Bug reports should be submitted via the Python Bug Tracker
+
+Documentation bugs
+==================
+
+If you find a bug in this documentation or would like to propose an improvement,
+please send an e-mail to docs@python.org describing the bug and where you found
+it.  If you have a suggestion how to fix it, include that as well.
+
+docs@python.org is a mailing list run by volunteers; your request will be
+noticed, even if it takes a while to be processed.
+
+Of course, if you want a more persistent record of your issue, you can use the
+issue tracker for documentation bugs as well.
+
+
+Using the Python issue tracker
+==============================
+
+Bug reports for Python itself should be submitted via the Python Bug Tracker
 (http://bugs.python.org/).  The bug tracker offers a Web form which allows
 pertinent information to be entered and submitted to the developers.
 
@@ -19,9 +37,6 @@ the problem has already been fixed for the next release, or additional
 information is needed (in which case you are welcome to provide it if you can!).
 To do this, search the bug database using the search box on the top of the page.
 
-In the case of documentation bugs, look at the most recent development docs at
-http://docs.python.org/dev to see if the bug has been fixed.
-
 If the problem you're reporting is not already in the bug tracker, go back to
 the Python Bug Tracker and log in.  If you don't already have a tracker account,
 select the "Register" link or, if you use OpenID, one of the OpenID provider

diff --git a/Doc/documenting/index.rst b/Doc/documenting/index.rst
index b64dc75ba56ef73a08e0e9fc3e4de9a37515af44..88d97be4df104160accfabc254b7ee6fdc4c5938 100644 (file)
--- a/Doc/documenting/index.rst
+++ b/Doc/documenting/index.rst
@@ -18,12 +18,17 @@ should be used, as well as the Sphinx build system.
 .. _docutils: http://docutils.sf.net/
 .. _Sphinx: http://sphinx.pocoo.org/
 
-If you're interested in contributing to Python's documentation, there's no need
-to write reStructuredText if you're not so inclined; plain text contributions
-are more than welcome as well.
+.. note::
+
+   If you're interested in contributing to Python's documentation, there's no
+   need to write reStructuredText if you're not so inclined; plain text
+   contributions are more than welcome as well.  Send an e-mail to
+   docs@python.org or open an issue on the :ref:`tracker <reporting-bugs>`.
+
 
 .. toctree::
    :numbered:
+   :maxdepth: 1
 
    intro.rst
    style.rst

diff --git a/Doc/tools/sphinxext/indexsidebar.html b/Doc/tools/sphinxext/indexsidebar.html
index cf7e11f3272ba9d6255daad653ecdf7e6de4c4b7..4aa631c74fb665920566b870e2520ae9ac8fdb71 100644 (file)
--- a/Doc/tools/sphinxext/indexsidebar.html
+++ b/Doc/tools/sphinxext/indexsidebar.html
@@ -19,4 +19,5 @@
               <li><a href="http://wiki.python.org/moin/PythonBooks">Book List</a></li>
               <li><a href="http://www.python.org/doc/av/">Audio/Visual Talks</a></li>
               <li><a href="http://www.python.org/doc/other/">Other Doc Collections</a></li>
+              <li><a href="{{ pathto('bugs') }}">Report a Bug</a></li>
             </ul>

diff --git a/Doc/tools/sphinxext/layout.html b/Doc/tools/sphinxext/layout.html
index 42e18a402e9cce3a3ed4aadaee9afacae8650d6f..a2561811305b2ae2b109bcda7ec196de4e5c2395 100644 (file)
--- a/Doc/tools/sphinxext/layout.html
+++ b/Doc/tools/sphinxext/layout.html
@@ -16,6 +16,18 @@
     <a href="http://www.python.org/psf/donations/">Please donate.</a>
     <br />
     Last updated on {{ last_updated|e }}.
+    <a href="{{ pathto('bugs') }}">Found a bug</a>?
+    <br />
     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version|e }}.
     </div>
 {% endblock %}
+{% block sidebarsourcelink %}
+{%- if show_source and has_source and sourcename %}
+<h3>{{ _('This Page') }}</h3>
+<ul class="this-page-menu">
+  <li><a href="{{ pathto('bugs') }}">Report a Bug</a></li>
+  <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
+         rel="nofollow">Show Source</a></li>
+</ul>
+{%- endif %}
+{% endblock %}