Skip to content

Commit facd6f8

Browse files
nedbatnedbat
authored
Populate the docs section of the new contrib structure (#1454)
* mark the plan page as an aside to the reviewer * link to the internals section from the contrib mention of it * contrib: populate the docs section Also added a pull-request-lifecycle page to the Code section.
1 parent d666cba commit facd6f8

12 files changed

+137
-11
lines changed

‎contrib/code/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Code contributions
1313
[We'll include code-focused content from the :ref:`main devguide page <devguide-main>`: Quick
1414
reference, Quick links, Proposing changes, and so on.]
1515

16-
[The existing "CPython's internals" section of the devguide will be fully
16+
[The existing :ref:`internals` section of the devguide will be fully
1717
migrated into the Python repo.]
1818

1919

@@ -22,6 +22,7 @@ migrated into the Python repo.]
2222

2323
setup
2424
git
25+
pull-request-lifecycle
2526
developer-workflow
2627
testing
2728
development-tools

‎contrib/code/pull-request-lifecycle.rst

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. _code-pull-request-lifecycle:
2+
3+
======================
4+
Pull request lifecycle
5+
======================
6+
7+
.. important::
8+
9+
|draft|
10+
11+
|purpose|
12+
13+
14+
[Details of pull requests for code contributions. The existing
15+
:ref:`pull-request-lifecycle` page is long and includes many details.
16+
Some only apply to code contributions, but many are common to all
17+
contributions. Should we keep a common page, with extra steps here, or
18+
should this page have all of the details even if they are duplicated
19+
elsewhere?]
20+
21+
[See :ref:`docs-pull-request-lifecycle` for the documentation half of this conundrum.]

‎contrib/contrib-plan.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _contrib-plan:
22

3-
================================
4-
Plan for the Contributor's Guide
5-
================================
3+
==================================
4+
[Plan for the Contributor's Guide]
5+
==================================
66

77
.. important::
88

‎contrib/doc/devguide.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
==================================
2+
Helping with the Developer's Guide
3+
==================================
4+
5+
.. important::
6+
7+
|draft|
8+
9+
|purpose|
10+
11+
12+
[This is the existing :ref:`devguide` page from the devguide.]

‎contrib/doc/help-documenting.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
==========================
2+
Helping with documentation
3+
==========================
4+
5+
.. important::
6+
7+
|draft|
8+
9+
|purpose|
10+
11+
12+
[This is the existing :ref:`help-documenting` page from the devguide.]

‎contrib/doc/index.rst

+16-7
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,19 @@ Documentation contributions
99
|purpose|
1010

1111

12-
* Lifecycle of a docs pull request
13-
* (pull in Documentation sections from devguide)
14-
* Rst/Sphinx bootcamp
15-
* Editorial Style Guide
16-
* Translation
17-
- How to add a new language
18-
- Tools and workflow
12+
[The main page for documentation contributors.]
13+
14+
[We'll include docs-focused content from the :ref:`main devguide page <devguide-main>`: Quick
15+
reference, Quick links, and so on.]
16+
17+
18+
.. toctree::
19+
:maxdepth: 5
20+
21+
start-documenting
22+
help-documenting
23+
style-guide
24+
markup
25+
pull-request-lifecycle
26+
translating
27+
devguide

‎contrib/doc/markup.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
=======================
2+
reStructuredText markup
3+
=======================
4+
5+
.. important::
6+
7+
|draft|
8+
9+
|purpose|
10+
11+
12+
[This is the existing :ref:`markup` page from the devguide.]

‎contrib/doc/pull-request-lifecycle.rst

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. _docs-pull-request-lifecycle:
2+
3+
======================
4+
Pull request lifecycle
5+
======================
6+
7+
.. important::
8+
9+
|draft|
10+
11+
|purpose|
12+
13+
14+
[Details of pull requests for documentation contributions. The existing
15+
:ref:`pull-request-lifecycle` page is long and includes many details.
16+
Some only apply to code contributions, but many are common to all
17+
contributions. Should we keep a common page, with documentation tweaks here, or
18+
should this page have only the documentation details even if they are duplicated
19+
elsewhere?]
20+
21+
[See :ref:`code-pull-request-lifecycle` for the code half of this conundrum.]

‎contrib/doc/start-documenting.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
===============
2+
Getting started
3+
===============
4+
5+
.. important::
6+
7+
|draft|
8+
9+
|purpose|
10+
11+
12+
[This is the existing documentation :ref:`start-documenting` page from the devguide.]

‎contrib/doc/style-guide.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
===========
2+
Style guide
3+
===========
4+
5+
.. important::
6+
7+
|draft|
8+
9+
|purpose|
10+
11+
12+
[This is the existing documentation :ref:`style-guide` page from the devguide.]

‎contrib/doc/translating.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
===========
2+
Translating
3+
===========
4+
5+
.. important::
6+
7+
|draft|
8+
9+
|purpose|
10+
11+
12+
[This is the existing :ref:`translating` page from the devguide.]

‎internals/index.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _internals:
2+
13
===================
24
CPython's internals
35
===================

0 commit comments

Comments
 (0)