Skip to content

Commit b5757b6

Browse files
AA-Turnerezio-melotti
authored andcommitted
Update for structure
1 parent ce0c44f commit b5757b6

File tree

5 files changed

+13
-11
lines changed

5 files changed

+13
-11
lines changed

documentation/help-documenting.rst

+2-3
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,9 @@ This high-level **Helping with Documentation** section provides:
1414
* an overview of Python's documentation
1515
* how to help with documentation issues
1616
* information on proofreading
17-
* guidance on contributing to this Developer's Guide
1817

19-
The next chapter, :ref:`Documenting Python <documenting>`, gives extensive,
20-
detailed information on how to write documentation and submit changes.
18+
You will find extensive and detailed information on how to write documentation
19+
and submit changes on the :ref:`Documenting Python <documenting>` page.
2120

2221

2322
Python Documentation

documentation/markup.rst

+5-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ reStructuredText Markup
66

77
.. highlight:: rest
88

9+
This document describes the custom reStructuredText markup introduced by Sphinx
10+
to support Python documentation and how it should be used.
11+
912

1013
.. _rst-primer:
1114

@@ -190,7 +193,8 @@ A directive is a generic block of explicit markup. Besides roles, it is one of
190193
the extension mechanisms of reST, and Sphinx makes heavy use of it.
191194

192195
Basically, a directive consists of a name, arguments, options and content. (Keep
193-
this terminology in mind, it is used in the next chapter describing custom
196+
this terminology in mind, it is used in `:ref:`the next section
197+
<Additional Markup Constructs>` describing custom
194198
directives.) Looking at this example,
195199

196200
::

documentation/start-documenting.rst

+2-6
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@ contributed by various authors. The markup used for the Python documentation is
1111
`reStructuredText`_, developed by the `docutils`_ project, amended by custom
1212
directives and using a toolset named `Sphinx`_ to post-process the HTML output.
1313

14-
This document describes the style guide for our documentation as well as the
15-
custom reStructuredText markup introduced by Sphinx to support Python
16-
documentation and how it should be used.
17-
1814
The documentation in HTML, PDF or EPUB format is generated from text files
1915
written using the :ref:`reStructuredText format <markup>` and contained in the
2016
:ref:`CPython Git repository <setup>`.
@@ -43,7 +39,7 @@ The involvement of the community takes many forms, from authoring to bug reports
4339
to just plain complaining when the documentation could be more complete or
4440
easier to use.
4541

46-
This document is aimed at authors and potential authors of documentation for
42+
This section is aimed at authors and potential authors of documentation for
4743
Python. More specifically, it is for people contributing to the standard
4844
documentation and developing additional documents using the same tools as the
4945
standard documents. This guide will be less useful for authors using the Python
@@ -56,7 +52,7 @@ documented here, there's a welcoming place for you among the Python contributors
5652
as well. Any time you feel that you can clarify existing documentation or
5753
provide documentation that's missing, the existing documentation team will
5854
gladly work with you to integrate your text, dealing with the markup for you.
59-
Please don't let the material in this document stand between the documentation
55+
Please don't let the material in this section stand between the documentation
6056
and your desire to help out!
6157

6258

documentation/style-guide.rst

+3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ Style Guide
66

77
.. highlight:: rest
88

9+
This document describes the style guide for our documentation.
10+
11+
912
Use of whitespace
1013
=================
1114

testing/new-buildbot-worker.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ supported by corporations. Even the corporate sponsored buildbots, however,
1414
tend to exist because some individual championed them, made them a reality, and
1515
is committed to maintaining them.
1616

17-
Anyone can contribute a buildbot to the fleet. This chapter describes how
17+
Anyone can contribute a buildbot to the fleet. This document describes how
1818
to go about setting up a buildbot worker, getting it added, and some hints about
1919
buildbot maintenance.
2020

0 commit comments

Comments
 (0)