Skip to content

Navigation Menu

Sign in

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 2abd354

Browse filesBrowse files
story645story645
committed
applying toc styling to remove nesting
updating to sphinx7.4.0 to use new toctree :class: attribute change "new contributors" section title to "contributing guide" add copy to anchor each section of devel/index small doc cleanups based on above
1 parent 9b8a8c7 commit 2abd354
Copy full SHA for 2abd354

File tree

6 files changed

+48
-36
lines changed
Filter options

6 files changed

+48
-36
lines changed

‎doc/devel/contribute.rst

Copy file name to clipboardExpand all lines: doc/devel/contribute.rst
+4-7Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
.. _contributing:
44

5-
**********
6-
Contribute
7-
**********
5+
******************
6+
Contributing guide
7+
******************
8+
89

910
You've discovered a bug or something else you want to change
1011
in Matplotlib — excellent!
@@ -13,10 +14,6 @@ You've worked out a way to fix it — even better!
1314

1415
You want to tell us about it — best of all!
1516

16-
This project is a community effort, and everyone is welcome to contribute. Everyone
17-
within the community is expected to abide by our `code of conduct
18-
<https://github.com/matplotlib/matplotlib/blob/main/CODE_OF_CONDUCT.md>`_.
19-
2017
Below, you can find a number of ways to contribute, and how to connect with the
2118
Matplotlib community.
2219

‎doc/devel/index.rst

Copy file name to clipboardExpand all lines: doc/devel/index.rst
+35-22Lines changed: 35 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,26 @@ Contribute
1616
:octicon:`heart;1em;sd-text-info` Thank you for your interest in helping to improve
1717
Matplotlib! :octicon:`heart;1em;sd-text-info`
1818

19-
There are various ways to contribute: optimizing and refactoring code, detailing
20-
unclear documentation and writing new examples, helping the community, reporting
21-
and fixing bugs and requesting and implementing new features...
19+
This project is a community effort, and everyone is welcome to contribute. Everyone
20+
within the community is expected to abide by our :ref:`code of conduct <code_of_conduct>`.
21+
22+
There are various ways to contribute, such as optimizing and refactoring code,
23+
detailing unclear documentation and writing new examples, helping the community,
24+
reporting and fixing bugs, requesting and implementing new features...
2225

2326
.. _submitting-a-bug-report:
2427
.. _request-a-new-feature:
2528

29+
Issue tracker
30+
=============
31+
The `issue tracker <https://github.com/matplotlib/matplotlib/issues>`_ serves as the
32+
centralized location for making feature requests, reporting bugs, identifying major
33+
projects to work on, and discussing priorities.
34+
35+
We have preloaded the issue creation page with markdown forms requesting the information
36+
we need to triage issues and we welcome you to add any additional information or
37+
context that may be necessary for resolving the issue:
38+
2639
.. grid:: 1 1 2 2
2740

2841
.. grid-item-card::
@@ -31,9 +44,7 @@ and fixing bugs and requesting and implementing new features...
3144
:octicon:`bug;1em;sd-text-info` **Submit a bug report**
3245
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3346

34-
We have preloaded the issue creation page with a Markdown form that you can
35-
use to provide relevant context. Thank you for your help in keeping bug reports
36-
complete, targeted and descriptive.
47+
Thank you for your help in keeping bug reports complete, targeted and descriptive.
3748

3849
.. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose
3950
:expand:
@@ -47,27 +58,24 @@ and fixing bugs and requesting and implementing new features...
4758
:octicon:`light-bulb;1em;sd-text-info` **Request a new feature**
4859
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4960

50-
We will give feedback on the feature proposal. Since
51-
Matplotlib is an open source project with limited resources, we encourage
52-
users to then also :ref:`participate in the implementation <contribute_code>`.
61+
Thank you for your help in keeping feature requests well defined and tightly scoped.
5362

5463
.. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose
5564
:expand:
5665
:color: primary
5766

5867
Request a feature
5968

69+
Since Matplotlib is an open source project with limited resources, we encourage users
70+
to then also :ref:`participate <contribute_code>` in fixing bugs and implementing new
71+
features.
72+
73+
Contributing guide
74+
==================
6075

6176
We welcome you to get more involved with the Matplotlib project! If you are new
6277
to contributing, we recommend that you first read our
63-
:ref:`contributing guide<contributing>`. If you are contributing code or
64-
documentation, please follow our guides for setting up and managing a
65-
:ref:`development environment and workflow<development_environment>`.
66-
For code, documentation, or triage, please follow the corresponding
67-
:ref:`contribution guidelines <contribution_guideline>`.
68-
69-
New contributors
70-
================
78+
:ref:`contributing guide<contributing>`:
7179

7280
.. toctree::
7381
:hidden:
@@ -115,13 +123,13 @@ New contributors
115123

116124
:octicon:`globe;1em;sd-text-info` Build community
117125

118-
119-
120-
121126
.. _development_environment:
122127

123-
Development environment
124-
=======================
128+
Development workflow
129+
====================
130+
131+
If you are contributing code or documentation, please follow our guide for setting up
132+
and managing a development environment and workflow:
125133

126134
.. grid:: 1 1 2 2
127135

@@ -159,6 +167,11 @@ Development environment
159167
Policies and guidelines
160168
=======================
161169

170+
These policies and guidelines help us maintain consistency in the various types
171+
of maintenance work. If you are writing code or documentation, following these policies
172+
helps maintainers more easily review your work. If you are helping triage, community
173+
manage, or release manage, these guidelines describe how our current process works.
174+
162175
.. grid:: 1 1 2 2
163176
:class-row: sf-fs-1
164177
:gutter: 2

‎doc/devel/tag_guidelines.rst

Copy file name to clipboardExpand all lines: doc/devel/tag_guidelines.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ title or the scope of the example.
4545

4646
**Tag Categories**
4747
^^^
48-
.. rst-class:: section-toc
4948

5049
.. toctree::
5150
:maxdepth: 2
51+
:class: section-toc
5252

5353
tag_glossary
5454

‎doc/index.rst

Copy file name to clipboardExpand all lines: doc/index.rst
+6-4Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Install
3232
.. tab-item:: other
3333

3434
.. toctree::
35+
:class: section-toc
3536
:maxdepth: 2
3637

3738
install/index
@@ -107,6 +108,7 @@ Community
107108
.. grid-item::
108109

109110
.. toctree::
111+
:class: section-toc
110112
:maxdepth: 2
111113

112114
users/resources/index.rst
@@ -144,12 +146,12 @@ Contribute
144146

145147
.. grid-item::
146148

147-
Matplotlib is a community project maintained for and by its users.
148-
149-
There are many ways you can help!
149+
Matplotlib is a community project maintained for and by its users. See
150+
:ref:`developers-guide-index` for the many ways you can help!
150151

151152
.. grid-item::
152153
.. toctree::
154+
:class: section-toc
153155
:maxdepth: 2
154156

155157
devel/index.rst
@@ -168,8 +170,8 @@ About us
168170
and hard things possible.
169171

170172
.. grid-item::
171-
172173
.. toctree::
174+
:class: section-toc
173175
:maxdepth: 2
174176

175177
project/index.rst

‎environment.yml

Copy file name to clipboardExpand all lines: environment.yml
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ dependencies:
3737
- packaging>=20
3838
- pydata-sphinx-theme~=0.15.0
3939
- pyyaml
40-
- sphinx>=3.0.0,!=6.1.2
40+
- sphinx>=7.4.0,!=6.1.2
4141
- sphinx-copybutton
4242
- sphinx-gallery>=0.12.0
4343
- sphinx-design

‎requirements/doc/doc-requirements.txt

Copy file name to clipboardExpand all lines: requirements/doc/doc-requirements.txt
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# Install the documentation requirements with:
88
# pip install -r requirements/doc/doc-requirements.txt
99
#
10-
sphinx>=3.0.0,!=6.1.2
10+
sphinx>=7.4.0,!=6.1.2
1111
colorspacious
1212
ipython
1313
ipywidgets

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.