8000 Populate the docs section of the new contrib structure by nedbat · Pull Request #1454 · python/devguide · GitHub
[go: up one dir, main page]
Skip to content

Populate the docs section of the new contrib structure #1454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 23, 2024
Merged

Populate the docs section of the new contrib structure #1454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ccee30
mark the plan page as an aside to the reviewer
nedbat Oct 19, 2024
3bd13a3
link to the internals section from the contrib mention of it
nedbat Oct 23, 2024
667f2e7
contrib: populate the docs section
nedbat Oct 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion contrib/code/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Code contributions
[We'll include code-focused content from the :ref:`main devguide page <devguide-main>`: Quick
reference, Quick links, Proposing changes, and so on.]

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


Expand All @@ -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
View file
Open in desktop
< 8000 table class=" diff-table js-diff-table tab-size " data-tab-size="3" data-diff-anchor="diff-d38de049899a88fc7d1d90f50e1236db5186f4279ebd119c24962b900c7e3725" data-paste-markdown-skip> 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.]
6 changes: 3 additions & 3 deletions contrib/contrib-plan.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _contrib-plan:

================================
Plan for the Contributor's Guide
================================
==================================
[Plan for the Contributor's Guide]
==================================

.. important::

Expand Down
12 changes: 12 additions & 0 deletions contrib/doc/devguide.rst
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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.]
2 changes: 2 additions & 0 deletions internals/index.rst
View file
Open in desktop
Original file line number Diff line nu 801 mber Diff line change
@@ -1,3 +1,5 @@
.. _internals:

===================
CPython's internals
===================
Expand Down
Loading
0