Skip to content

DOC: apply toc styling to remove nesting #28557

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 1 commit into from
Jul 23, 2024
Merged

DOC: apply toc styling to remove nesting #28557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 5 additions & 8 deletions doc/devel/contribute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

.. _contributing:

**********
Contribute
**********
******************
Contributing guide
******************


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

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

This project is a community effort, and everyone is welcome to contribute. Everyone
within the community is expected to abide by our `code of conduct
<https://github.com/matplotlib/matplotlib/blob/main/CODE_OF_CONDUCT.md>`_.

Below, you can find a number of ways to contribute, and how to connect with the
Matplotlib community.

Expand Down Expand Up @@ -275,7 +272,7 @@ repository <https://github.com/matplotlib/matplotlib/>`__ on GitHub,
then submit a "pull request" (PR). You can do this by cloning a copy of the
Maplotlib repository to your own computer, or alternatively using
`GitHub Codespaces <https://docs.github.com/codespaces>`_, a cloud-based
in-browser development environment that comes with the appropriated setup to
in-browser development environment that comes with the appropriate setup to
contribute to Matplotlib.

Workflow overview
Expand Down
58 changes: 36 additions & 22 deletions doc/devel/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,27 @@ Contribute
:octicon:`heart;1em;sd-text-info` Thank you for your interest in helping to improve
Matplotlib! :octicon:`heart;1em;sd-text-info`

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

There are various ways to contribute, such as optimizing and refactoring code,
detailing unclear documentation and writing new examples, helping the community,
reporting and fixing bugs, requesting and implementing new features...

.. _submitting-a-bug-report:
.. _request-a-new-feature:

GitHub issue tracker
====================

The `issue tracker <https://github.com/matplotlib/matplotlib/issues>`_ serves as the
centralized location for making feature requests, reporting bugs, identifying major
projects to work on, and discussing priorities.

We have preloaded the issue creation page with markdown forms requesting the information
we need to triage issues and we welcome you to add any additional information or
context that may be necessary for resolving the issue:

.. grid:: 1 1 2 2

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

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

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

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

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

Request a feature

Since Matplotlib is an open source project with limited resources, we encourage users
to also :ref:`participate <contribute_code>` in fixing bugs and implementing new
features.

Contributing guide
==================

We welcome you to get more involved with the Matplotlib project! If you are new
to contributing, we recommend that you first read our
:ref:`contributing guide<contributing>`. If you are contributing code or
documentation, please follow our guides for setting up and managing a
:ref:`development environment and workflow<development_environment>`.
For code, documentation, or triage, please follow the corresponding
:ref:`contribution guidelines <contribution_guideline>`.

New contributors
================
:ref:`contributing guide<contributing>`:

.. toctree::
:hidden:
Expand Down Expand Up @@ -115,13 +124,13 @@ New contributors

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




.. _development_environment:

Development environment
=======================
Development workflow
====================

If you are contributing code or documentation, please follow our guide for setting up
and managing a development environment and workflow:

.. grid:: 1 1 2 2

Expand Down Expand Up @@ -159,6 +168,11 @@ Development environment
Policies and guidelines
=======================

These policies and guidelines help us maintain consistency in the various types
of maintenance work. If you are writing code or documentation, following these policies
helps maintainers more easily review your work. If you are helping triage, community
manage, or release manage, these guidelines describe how our current process works.

.. grid:: 1 1 2 2
:class-row: sf-fs-1
:gutter: 2
Expand Down
10 changes: 6 additions & 4 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Install
.. tab-item:: other

.. rst-class:: section-toc
.. toctree::
:maxdepth: 2

Expand Down Expand Up @@ -106,6 +107,7 @@ Community

.. grid-item::

.. rst-class:: section-toc
.. toctree::
:maxdepth: 2

Expand Down Expand Up @@ -144,11 +146,11 @@ Contribute

.. grid-item::

Matplotlib is a community project maintained for and by its users.

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

.. grid-item::
.. rst-class:: section-toc
.. toctree::
:maxdepth: 2

Expand All @@ -168,7 +170,7 @@ About us
and hard things possible.

.. grid-item::

.. rst-class:: section-toc
.. toctree::
:maxdepth: 2

Expand Down