diff --git a/doc/index.rst b/doc/index.rst index 8351599204b8..aa943225c275 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,224 +1,45 @@ :orphan: -.. title:: Matplotlib: Python plotting +.. title:: Matplotlib documentation .. module:: matplotlib -Matplotlib: Visualization with Python -------------------------------------- +Matplotlib documentation +------------------------ + +Release: |release| Matplotlib is a comprehensive library for creating static, animated, and interactive visualizations in Python. -.. raw:: html - -
- -
- screenshots -
-
- screenshots -
-
- screenshots -
-
- screenshots -
- -
- - -Matplotlib makes easy things easy and hard things possible. - -.. container:: bullet-box-container - - .. container:: bullet-box - - Create - - - Develop `publication quality plots`_ with just a few lines of code - - Use `interactive figures`_ that can zoom, pan, update... - - .. _publication quality plots: https://matplotlib.org/gallery/index.html - .. _interactive figures: https://matplotlib.org/gallery/index.html#event-handling - - .. container:: bullet-box - - Customize - - - `Take full control`_ of line styles, font properties, axes properties... - - `Export and embed`_ to a number of file formats and interactive environments - - .. _Take full control: https://matplotlib.org/tutorials/index.html#tutorials - .. _Export and embed: https://matplotlib.org/api/index_backend_api.html - - .. container:: bullet-box - - Extend - - - Explore tailored functionality provided by - `third party packages `_ - - Learn more about Matplotlib through the many - :doc:`external learning resources ` - -Documentation -~~~~~~~~~~~~~ - -To get started, read the :doc:`User's Guide `. - -Trying to learn how to do a particular kind of plot? Check out the -:doc:`examples gallery ` or the :doc:`list of plotting commands -`. - -Join our community! -~~~~~~~~~~~~~~~~~~~ - -Matplotlib is a welcoming, inclusive project, and everyone within the community -is expected to abide by our `code of conduct -`_. - - -.. raw:: html - -

Get help

-
-
- Discourse -

Join our community at discourse.matplotlib.org - to get help, discuss contributing & development, and share your work.

-
-
- Questions -

If you have questions, be sure to check the FAQ, - the API docs. The full text - search is a good way to discover the docs including the many examples.

-
-
- Stackoverflow -

Check out the Matplotlib tag on stackoverflow.

-
-
- Gitter -

Short questions may be posted on the gitter channel.

-
-
-
-

News

-
-
- News -

To keep up to date with what's going on in Matplotlib, see the - what's new page or browse the - source code. Anything that could - require changes to your existing code is logged in the - API changes file.

-
-
- Social media - -
-
-
-

Development

-
-
- Github -

Matplotlib is hosted on GitHub.

- -

It is a good idea to ping us on Discourse as well.

-
-
- Mailing lists -

Mailing lists

- -
-
- - -Toolkits -======== - -Matplotlib ships with several add-on :doc:`toolkits `, -including 3D plotting with `.mplot3d`, axes helpers in `.axes_grid1` and axis -helpers in `.axisartist`. - -Third party packages -==================== - -A large number of -`third party packages `_ -extend and build on Matplotlib functionality, including several higher-level -plotting interfaces (seaborn_, HoloViews_, ggplot_, ...), and a projection -and mapping toolkit (Cartopy_). - -.. _seaborn: https://seaborn.pydata.org -.. _HoloViews: https://holoviews.org -.. _ggplot: https://yhat.github.io/ggpy/ -.. _Cartopy: https://scitools.org.uk/cartopy/docs/latest/ - -Citing Matplotlib -================= - -Matplotlib is the brainchild of John Hunter (1968-2012), who, along with its -many contributors, have put an immeasurable amount of time and effort into -producing a piece of software utilized by thousands of scientists worldwide. - -If Matplotlib contributes to a project that leads to a scientific publication, -please acknowledge this work by citing the project. A :doc:`ready-made citation -entry ` is available. - -Open source -=========== - -.. raw:: html - - - A Fiscally Sponsored Project of NUMFocus - - +Learn +===== + +- :doc:`Quick-start Guide ` +- Basic :doc:`Plot Types ` and :doc:`Example Gallery ` +- `Introductory Tutorials <../tutorials/index.html#introductory>`_ + +Reference +========= -Matplotlib is a Sponsored Project of NumFOCUS, a 501(c)(3) nonprofit -charity in the United States. NumFOCUS provides Matplotlib with -fiscal, legal, and administrative support to help ensure the health -and sustainability of the project. Visit `numfocus.org `_ for more -information. +- :doc:`API Reference ` -Donations to Matplotlib are managed by NumFOCUS. For donors in the -United States, your gift is tax-deductible to the extent provided by -law. As with any donation, you should consult with your tax adviser -about your particular tax situation. + - :doc:`pyplot API `: top-level interface to create + Figures (`.pyplot.figure`) and Subplots (`.pyplot.subplots`, + `.pyplot.subplot_mosaic`) + - :doc:`Axes API ` for *most* plotting methods + - :doc:`Figure API ` for figure-level methods -Please consider `donating to the Matplotlib project `_ through -the NumFOCUS organization or to the `John Hunter Technology Fellowship -`_. +- :doc:`Extra Toolkits ` -.. _donating: https://numfocus.org/donate-to-matplotlib -.. _jdh-fellowship: https://numfocus.org/programs/john-hunter-technology-fellowship/ -.. _nf: https://numfocus.org +How-tos +======= -The :doc:`Matplotlib license ` is based on the `Python Software -Foundation (PSF) license `_. +- :doc:`Installation Guide ` +- :doc:`Contributing to Matplotlib ` +- :doc:`Matplotlib FAQ ` -.. _psf-license: https://docs.python.org/3/license.html +Understand how Matplotlib works +=============================== -There is an active developer community and a long list of people who have made -significant :doc:`contributions `. +- Many of the :doc:`Tutorials ` have explanatory material