Skip to content

Commit

Permalink
contrib: populate the docs section
Browse files Browse the repository at this point in the history
Also added a pull-request-lifecycle page to the Code section.
  • Loading branch information
nedbat committed Oct 23, 2024
1 parent 3bd13a3 commit 667f2e7
Show file tree
Hide file tree
Showing 10 changed files with 131 additions and 7 deletions.
1 change: 1 addition & 0 deletions contrib/code/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ migrated into the Python repo.]

setup
git
pull-request-lifecycle
developer-workflow
testing
development-tools
21 changes: 21 additions & 0 deletions contrib/code/pull-request-lifecycle.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. _code-pull-request-lifecycle:

======================
Pull request lifecycle
======================

.. important::

|draft|

|purpose|


[Details of pull requests for code contributions. The existing
:ref:`pull-request-lifecycle` page is long and includes many details.
Some only apply to code contributions, but many are common to all
contributions. Should we keep a common page, with extra steps here, or
should this page have all of the details even if they are duplicated
elsewhere?]

[See :ref:`docs-pull-request-lifecycle` for the documentation half of this conundrum.]
12 changes: 12 additions & 0 deletions contrib/doc/devguide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
==================================
Helping with the Developer's Guide
==================================

.. important::

|draft|

|purpose|


[This is the existing :ref:`devguide` page from the devguide.]
12 changes: 12 additions & 0 deletions contrib/doc/help-documenting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
==========================
Helping with documentation
==========================

.. important::

|draft|

|purpose|


[This is the existing :ref:`help-documenting` page from the devguide.]
23 changes: 16 additions & 7 deletions contrib/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,19 @@ Documentation contributions
|purpose|


* Lifecycle of a docs pull request
* (pull in Documentation sections from devguide)
* Rst/Sphinx bootcamp
* Editorial Style Guide
* Translation
- How to add a new language
- Tools and workflow
[The main page for documentation contributors.]

[We'll include docs-focused content from the :ref:`main devguide page <devguide-main>`: Quick
reference, Quick links, and so on.]


.. toctree::
:maxdepth: 5

start-documenting
help-documenting
style-guide
markup
pull-request-lifecycle
translating
devguide
12 changes: 12 additions & 0 deletions contrib/doc/markup.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
=======================
reStructuredText markup
=======================

.. important::

|draft|

|purpose|


[This is the existing :ref:`markup` page from the devguide.]
21 changes: 21 additions & 0 deletions contrib/doc/pull-request-lifecycle.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. _docs-pull-request-lifecycle:

======================
Pull request lifecycle
======================

.. important::

|draft|

|purpose|


[Details of pull requests for documentation contributions. The existing
:ref:`pull-request-lifecycle` page is long and includes many details.
Some only apply to code contributions, but many are common to all
contributions. Should we keep a common page, with documentation tweaks here, or
should this page have only the documentation details even if they are duplicated
elsewhere?]

[See :ref:`code-pull-request-lifecycle` for the code half of this conundrum.]
12 changes: 12 additions & 0 deletions contrib/doc/start-documenting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
===============
Getting started
===============

.. important::

|draft|

|purpose|


[This is the existing documentation :ref:`start-documenting` page from the devguide.]
12 changes: 12 additions & 0 deletions contrib/doc/style-guide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
===========
Style guide
===========

.. important::

|draft|

|purpose|


[This is the existing documentation :ref:`style-guide` page from the devguide.]
12 changes: 12 additions & 0 deletions contrib/doc/translating.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
===========
Translating
===========

.. important::

|draft|

|purpose|


[This is the existing :ref:`translating` page from the devguide.]

0 comments on commit 667f2e7

Please sign in to comment.