Thanks to visit codestin.com
Credit goes to github.com

Skip to content

moved doc root to landing page, make user landing a guide page #26332

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 31, 2023
Merged

moved doc root to landing page, make user landing a guide page #26332

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
2 changes: 1 addition & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ def gallery_image_warning_filter(record):
source_encoding = "utf-8"

# The toplevel toctree document (renamed to root_doc in Sphinx 4.0)
root_doc = master_doc = 'users/index'
root_doc = master_doc = 'index'

# General substitutions.
try:
Expand Down
44 changes: 33 additions & 11 deletions doc/devel/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,16 @@ ways to contribute: optimizing and refactoring code, detailing unclear
documentation and writing new examples, reporting and fixing bugs and requesting
and implementing new features, helping the community...

New contributors
================

.. card::

.. grid:: 1 1 2 2
:class-row: sd-align-minor-center

.. grid-item::
:class: sd-fs-5
:child-align: spaced

:octicon:`info;1em;sd-text-info` :ref:`Where should I start? <start-contributing>`

Expand Down Expand Up @@ -67,12 +70,15 @@ For code, documentation, or triage, please follow the corresponding

.. _development_environment:

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

.. grid:: 1 1 2 2

.. grid-item-card:: Install
.. grid-item-card::

**Install**
^^^

.. toctree::
:maxdepth: 2
Expand All @@ -85,7 +91,10 @@ Development workflow
dependencies


.. grid-item-card:: Workflow
.. grid-item-card::

**Workflow**
^^^^

.. toctree::
:maxdepth: 2
Expand All @@ -96,13 +105,17 @@ Development workflow

.. _contribution_guideline:

Contribution guides
===================
Policies and guidelines
=======================

.. grid:: 1 1 2 2
:class-row: sf-fs-1
:gutter: 2

.. grid-item-card::

.. grid-item-card:: Code
**Code**
^^^

| :ref:`coding_guidelines`

Expand All @@ -112,21 +125,30 @@ Contribution guides
coding_guide
testing

.. grid-item-card:: Documentation
.. grid-item-card::

**Documentation**
^^^

.. toctree::
:maxdepth: 1

document
style_guide

.. grid-item-card:: Triage
.. grid-item-card::

**Triage**
^^^

| :ref:`bug_triaging`
| :ref:`triage_team`
| :ref:`triage_workflow`

.. grid-item-card:: Maintenance
.. grid-item-card::

**Maintenance**
^^^

.. toctree::
:maxdepth: 1
Expand Down
171 changes: 119 additions & 52 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
:orphan:

.. title:: Matplotlib documentation

.. module:: matplotlib
Expand All @@ -9,100 +7,169 @@
Matplotlib |release| documentation
##################################


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

************
Installation
************
Install
=======

.. grid:: 1 1 2 2
.. tab-set::
:class: sd-width-content-min

.. grid-item::

Install using `pip <https://pypi.org/project/matplotlib>`__:
.. tab-item:: pip

.. code-block:: bash

pip install matplotlib

.. grid-item::

Install using `conda <https://docs.continuum.io/anaconda/>`__:
.. tab-item:: conda

.. code-block:: bash

conda install -c conda-forge matplotlib

Further details are available in the :doc:`Installation Guide <users/installing/index>`.
.. tab-item:: other

.. toctree::
:maxdepth: 2

******************
Learning resources
******************
users/installing/index

For more detailed instructions, see the
:doc:`installation guide <users/installing/index>`.

Learn
=====

.. grid:: 1 1 2 2

.. grid-item-card::
:padding: 2
:columns: 6

Tutorials
**How to use Matplotlib?**
^^^
.. toctree::
:maxdepth: 1

- :ref:`Quick-start guide <quick_start>`
- :doc:`Plot types <plot_types/index>`
- :ref:`users-guide-using`
- :doc:`External learning resources <users/resources/index>`
users/explain/quick_start
User guide <users/index.rst>
tutorials/index.rst
users/faq/index.rst

.. grid-item-card::
:padding: 2
:columns: 6

How-tos
**What can Matplotlib do?**
^^^
.. toctree::
:maxdepth: 1

plot_types/index.rst
gallery/index.rst

- :doc:`Example gallery <gallery/index>`
- :doc:`Matplotlib FAQ <users/faq/index>`

.. grid-item-card::
:padding: 2
:columns: 12

Understand how Matplotlib works
**Reference**
^^^

- :ref:`users-guide-explain` in the :doc:`Users guide
<users/index>` has a number of advanced topics.
.. grid:: 1 1 2 2
:class-row: sd-align-minor-center

.. grid-item-card::
:padding: 2
.. grid-item::

Reference
^^^
.. toctree::
:maxdepth: 1

- :doc:`API Reference <api/index>`
- :doc:`Axes API <api/axes_api>` for most plotting methods
- :doc:`Figure API <api/figure_api>` for figure-level methods
- Top-level interfaces to create:
API reference <api/index>
Figure methods <api/figure_api>
Plotting methods <api/axes_api>

- Figures (`.pyplot.figure`)
- Subplots (`.pyplot.subplots`, `.pyplot.subplot_mosaic`)

.. grid-item::

********************
Third-party packages
********************
Top-level interfaces to create:

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

Community
=========

.. grid:: 1 1 2 2
:class-row: sd-align-minor-center

.. grid-item::

.. toctree::
:maxdepth: 2

users/resources/index.rst

.. grid-item::

:octicon:`link-external;1em;sd-text-info` `Third-party packages <https://matplotlib.org/mpl-third-party/>`_,

provide custom, domain specific, and experimental features, including
styles, colors, more plot types and backends, and alternative
interfaces.

What's new
==========

.. grid:: 1 1 2 2

************
Contributing
************
.. grid-item::

Learn about new features and API changes.

.. grid-item::

.. toctree::
:maxdepth: 1

users/release_notes.rst


Contribute
==========

.. grid:: 1 1 2 2
:class-row: sd-align-minor-center

.. grid-item::

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

There are many ways you can help!

.. grid-item::
.. toctree::
:maxdepth: 2

devel/index.rst

About us
========

.. grid:: 1 1 2 2
:class-row: sd-align-minor-center

.. grid-item::

Matplotlib was created by neurobiologist John Hunter to work with EEG
data. It grew to be used and developed by many people in many
different fields. John's goal was that Matplotlib make easy things easy
and hard things possible.

.. grid-item::

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

- 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/project/index.rst
Loading