Skip to content

Navigation Menu

Sign in
Appearance settings

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 f7f0e2a

Browse filesBrowse files
story645story645
committed
move root to landing page, make user landing a guide page
1 parent f27d081 commit f7f0e2a
Copy full SHA for f7f0e2a

File tree

7 files changed

+212
-222
lines changed
Filter options

7 files changed

+212
-222
lines changed

‎doc/_static/image-rotator.js

Copy file name to clipboardExpand all lines: doc/_static/image-rotator.js
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ document.addEventListener("DOMContentLoaded", function(event) {
2323
// rotate images in images-rotate directory:
2424
var ind = getRandomInt(images_rotate.length);
2525
var info = images_rotate[ind];
26-
var img_src = "../_images/" + info.image;
26+
var img_src = "_images/" + info.image;
2727
var caption = info.caption;
2828
var link = "https://matplotlib.org/stable/" + info.link;
2929
var html = '<a href="' + link + '">' +

‎doc/conf.py

Copy file name to clipboardExpand all lines: doc/conf.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ def gallery_image_warning_filter(record):
311311
source_encoding = "utf-8"
312312

313313
# The toplevel toctree document (renamed to root_doc in Sphinx 4.0)
314-
root_doc = master_doc = 'users/index'
314+
root_doc = master_doc = 'index'
315315

316316
# General substitutions.
317317
try:

‎doc/devel/index.rst

Copy file name to clipboardExpand all lines: doc/devel/index.rst
+7-4Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ ways to contribute: optimizing and refactoring code, detailing unclear
99
documentation and writing new examples, reporting and fixing bugs and requesting
1010
and implementing new features, helping the community...
1111

12+
New contributors
13+
================
14+
1215
.. card::
1316

1417
.. grid:: 1 1 2 2
@@ -67,8 +70,8 @@ For code, documentation, or triage, please follow the corresponding
6770

6871
.. _development_environment:
6972

70-
Development workflow
71-
====================
73+
Development environment
74+
=======================
7275

7376
.. grid:: 1 1 2 2
7477

@@ -96,8 +99,8 @@ Development workflow
9699

97100
.. _contribution_guideline:
98101

99-
Contribution guides
100-
===================
102+
Policies and guidelines
103+
=======================
101104

102105
.. grid:: 1 1 2 2
103106
:class-row: sf-fs-1

‎doc/index.rst

Copy file name to clipboard
+102-59Lines changed: 102 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
:orphan:
2-
31
.. title:: Matplotlib documentation
42

53
.. module:: matplotlib
@@ -9,100 +7,145 @@
97
Matplotlib |release| documentation
108
##################################
119

10+
1211
Matplotlib is a comprehensive library for creating static, animated,
1312
and interactive visualizations in Python.
1413

15-
************
16-
Installation
17-
************
18-
1914
.. grid:: 1 1 2 2
2015

2116
.. grid-item::
2217

23-
Install using `pip <https://pypi.org/project/matplotlib>`__:
18+
.. raw:: html
19+
20+
<div class="grid__intro" id="image_rotator"></div>
21+
22+
.. grid-item::
2423

25-
.. code-block:: bash
24+
.. toctree::
25+
:maxdepth: 2
26+
27+
plot_types/index.rst
28+
29+
30+
Install
31+
=======
32+
33+
.. grid:: 1 1 2 2
2634

27-
pip install matplotlib
35+
.. grid-item-card:: Try this first!
36+
37+
.. tab-set::
38+
39+
.. tab-item:: pip
40+
41+
.. code-block:: bash
42+
43+
pip install matplotlib
44+
45+
.. tab-item:: conda
46+
47+
.. code-block:: bash
48+
49+
conda install -c conda-forge matplotlib
50+
51+
Make first plot: :ref:`quick start <quick_start>`!
2852

2953
.. grid-item::
3054

31-
Install using `conda <https://docs.continuum.io/anaconda/>`__:
55+
.. toctree::
56+
:maxdepth: 2
57+
58+
users/installing/index.rst
59+
60+
Learn
61+
=====
3262

33-
.. code-block:: bash
63+
.. card:: How to use Matplotlib?
3464

35-
conda install -c conda-forge matplotlib
65+
.. grid:: 1 1 2 2
3666

37-
Further details are available in the :doc:`Installation Guide <users/installing/index>`.
67+
.. grid-item::
3868

69+
.. toctree::
70+
:maxdepth: 1
3971

40-
******************
41-
Learning resources
42-
******************
72+
users/explain/quick_start.rst
73+
users/index.rst
74+
tutorials/index.rst
75+
users/faq/index.rst
76+
77+
78+
.. grid-item::
79+
80+
.. toctree::
81+
:maxdepth: 1
82+
83+
gallery/index.rst
84+
API reference <api/index>
85+
Plotting reference <api/axes_api>
86+
Figures reference <api/figure_api>
87+
88+
89+
Ecosystem
90+
=========
4391

4492
.. grid:: 1 1 2 2
4593

4694
.. grid-item-card::
47-
:padding: 2
4895

49-
Tutorials
50-
^^^
96+
:octicon:`link-external;1em;sd-text-info` `Third-party packages <https://matplotlib.org/mpl-third-party/>`_
5197

52-
- :ref:`Quick-start guide <quick_start>`
53-
- :doc:`Plot types <plot_types/index>`
54-
- :ref:`users-guide-using`
55-
- :doc:`External learning resources <users/resources/index>`
98+
Custom, domain specific and experimental features, such as
99+
styling, alternative APIs, specialized plot types, backends and
100+
helper methods.
56101

57-
.. grid-item-card::
58-
:padding: 2
102+
.. grid-item::
59103

60-
How-tos
61-
^^^
104+
.. toctree::
105+
:maxdepth: 2
62106

63-
- :doc:`Example gallery <gallery/index>`
64-
- :doc:`Matplotlib FAQ <users/faq/index>`
107+
users/resources/index.rst
65108

66-
.. grid-item-card::
67-
:padding: 2
109+
`Scientific Python <https://scientific-python.org/>`_
68110

69-
Understand how Matplotlib works
70-
^^^
71111

72-
- :ref:`users-guide-explain` in the :doc:`Users guide
73-
<users/index>` has a number of advanced topics.
112+
About
113+
=====
74114

75-
.. grid-item-card::
76-
:padding: 2
115+
.. toctree::
116+
:maxdepth: 2
77117

78-
Reference
79-
^^^
118+
users/project/index.rst
80119

81-
- :doc:`API Reference <api/index>`
82-
- :doc:`Axes API <api/axes_api>` for most plotting methods
83-
- :doc:`Figure API <api/figure_api>` for figure-level methods
84-
- Top-level interfaces to create:
85120

86-
- Figures (`.pyplot.figure`)
87-
- Subplots (`.pyplot.subplots`, `.pyplot.subplot_mosaic`)
121+
Contribute
122+
==========
88123

124+
.. grid:: 1 1 2 2
125+
126+
.. grid-item::
127+
128+
Matplotlib is a community project maintained for and by
129+
its users and contributions of all kinds are very appreciated.
130+
131+
.. grid-item::
132+
.. toctree::
133+
:maxdepth: 2
89134

90-
********************
91-
Third-party packages
92-
********************
135+
devel/index.rst
93136

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

138+
Releases
139+
========
98140

99-
************
100-
Contributing
101-
************
141+
.. grid:: 1 1 2 2
102142

103-
Matplotlib is a community project maintained for and by its users. There are many ways
104-
you can help!
143+
.. grid-item::
144+
New versions are generally released every 6-8 months.
145+
New features and API changes are described in the release notes.
146+
147+
.. grid-item::
148+
.. toctree::
149+
:maxdepth: 2
105150

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

0 commit comments

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