8000 Cleanup index.rst sectioning by timhoffm · Pull Request #21453 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Cleanup index.rst sectioning #21453

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
Oct 25, 2021
Merged

Cleanup index.rst sectioning #21453

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
19 changes: 17 additions & 2 deletions doc/devel/documenting_mpl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,13 +138,28 @@ Formatting and style conventions
It is useful to strive for consistency in the Matplotlib documentation. Here
are some formatting and style conventions that are used.

Section name formatting
~~~~~~~~~~~~~~~~~~~~~~~
Section formatting
~~~~~~~~~~~~~~~~~~

For everything but top-level chapters, use ``Upper lower`` for
section titles, e.g., ``Possible hangups`` rather than ``Possible
Hangups``

We aim to follow the recommendations from the
`Python documentation <https://devguide.python.org/documenting/#sections>`_
and the `Sphinx reStructuredText documentation <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections>`_
for section markup characters, i.e.:

- ``#`` with overline, for parts. This is reserved for the main title in
``index.rst``. All other pages should start with "chapter" or lower.
- ``*`` with overline, for chapters
- ``=``, for sections
- ``-``, for subsections
- ``^``, for subsubsections
- ``"``, for paragraphs

This may not yet be applied consistently in existing docs.

Function arguments
~~~~~~~~~~~~~~~~~~

Expand Down
22 changes: 10 additions & 12 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@
.. module:: matplotlib


##################################
Matplotlib |release| documentation
----------------------------------
##################################

Matplotlib is a comprehensive library for creating static, animated,
and interactive visualizations in Python.

************
Installation
============
************

.. container:: twocol

Expand All @@ -35,9 +37,9 @@ Installation
Further details are available in the :doc:`Installation Guide <users/installing/index>`.


******************
Learning resources
==================

******************

.. panels::

Expand Down Expand Up @@ -81,26 +83,22 @@ Learning resources



********************
Third-party packages
--------------------
********************

There are many `Third-party packages
<https://matplotlib.org/mpl-third-party/>`_ built on top of and extending
Matplotlib.


************
Contributing
------------
************

Matplotlib is a community project maintained for and by its users. There are many ways
you can help!

- Help other users `on discourse <https://discourse.matplotlib.org>`__
- report a bug or request a feature `on GitHub <https://github.com/matplotlib/matplotlib/issues>`__
- or improve the :ref:`documentation and code <developers-guide-index>`


Users guide
-----------

The `contents of the docs <users/index.html>`_.
0