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 150aa4e

Browse filesBrowse files
story645story645
committed
old landing page sections + install/contribute/project/release from users
+ moved users index a level up
1 parent 22fd053 commit 150aa4e
Copy full SHA for 150aa4e

File tree

Expand file treeCollapse file tree

7 files changed

+236
-213
lines changed
Filter options
Expand file treeCollapse file tree

7 files changed

+236
-213
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
+33-11Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,16 @@ 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
18+
:class-row: sd-align-minor-center
1519

1620
.. grid-item::
1721
:class: sd-fs-5
18-
:child-align: spaced
1922

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

@@ -67,12 +70,15 @@ 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

75-
.. grid-item-card:: Install
78+
.. grid-item-card::
79+
80+
**Install**
81+
^^^
7682

7783
.. toctree::
7884
:maxdepth: 2
@@ -85,7 +91,10 @@ Development workflow
8591
dependencies
8692

8793

88-
.. grid-item-card:: Workflow
94+
.. grid-item-card::
95+
96+
**Workflow**
97+
^^^^
8998

9099
.. toctree::
91100
:maxdepth: 2
@@ -96,13 +105,17 @@ Development workflow
96105

97106
.. _contribution_guideline:
98107

99-
Contribution guides
100-
===================
108+
Policies and guidelines
109+
=======================
101110

102111
.. grid:: 1 1 2 2
103112
:class-row: sf-fs-1
113+
:gutter: 2
114+
115+
.. grid-item-card::
104116

105-
.. grid-item-card:: Code
117+
**Code**
118+
^^^
106119

107120
| :ref:`coding_guidelines`
108121
@@ -112,21 +125,30 @@ Contribution guides
112125
coding_guide
113126
testing
114127

115-
.. grid-item-card:: Documentation
128+
.. grid-item-card::
129+
130+
**Documentation**
131+
^^^
116132

117133
.. toctree::
118134
:maxdepth: 1
119135

120136
document
121137
style_guide
122138

123-
.. grid-item-card:: Triage
139+
.. grid-item-card::
140+
141+
**Triage**
142+
^^^
124143

125144
| :ref:`bug_triaging`
126145
| :ref:`triage_team`
127146
| :ref:`triage_workflow`
128147
129-
.. grid-item-card:: Maintenance
148+
.. grid-item-card::
149+
150+
**Maintenance**
151+
^^^
130152

131153
.. toctree::
132154
:maxdepth: 1

‎doc/index.rst

Copy file name to clipboard
+125-52Lines changed: 125 additions & 52 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,175 @@
97
Matplotlib |release| documentation
108
##################################
119

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

15-
************
16-
Installation
17-
************
11+
Matplotlib is a comprehensive library for creating static, animated,
12+
and interactive visualizations.
1813

19-
.. grid:: 1 1 2 2
14+
Install
15+
=======
2016

21-
.. grid-item::
17+
.. tab-set::
18+
:class: sd-width-content-min
2219

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

2522
.. code-block:: bash
2623
2724
pip install matplotlib
2825
29-
.. grid-item::
30-
31-
Install using `conda <https://docs.continuum.io/anaconda/>`__:
26+
.. tab-item:: conda
3227

3328
.. code-block:: bash
3429
3530
conda install -c conda-forge matplotlib
3631
37-
Further details are available in the :doc:`Installation Guide <users/installing/index>`.
32+
.. tab-item:: other
33+
34+
.. toctree::
35+
:maxdepth: 2
3836

37+
users/installing/index
3938

40-
******************
41-
Learning resources
42-
******************
39+
For more detailed instructions, see the
40+
:doc:`installation guide <users/installing/index>`.
41+
42+
Learn
43+
=====
44+
45+
Start at the :ref:`Quick Start <quick_start>` guide!
4346

4447
.. grid:: 1 1 2 2
4548

4649
.. grid-item-card::
4750
:padding: 2
51+
:columns: 6
4852

49-
Tutorials
53+
**How to use Matplotlib?**
5054
^^^
55+
.. toctree::
56+
:maxdepth: 1
5157

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>`
58+
59+
User guide <users/index.rst>
60+
tutorials/index.rst
61+
users/faq/index.rst
5662

5763
.. grid-item-card::
5864
:padding: 2
65+
:columns: 6
5966

60-
How-tos
67+
**What can Matplotlib do?**
6168
^^^
69+
.. toctree::
70+
:maxdepth: 1
71+
72+
plot_types/index.rst
73+
gallery/index.rst
6274

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

6676
.. grid-item-card::
6777
:padding: 2
78+
:columns: 12
6879

69-
Understand how Matplotlib works
80+
**Reference**
7081
^^^
7182

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

75-
.. grid-item-card::
76-
:padding: 2
86+
.. grid-item::
7787

78-
Reference
79-
^^^
88+
.. toctree::
89+
:maxdepth: 1
8090

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:
91+
API reference <api/index>
92+
Figure methods <api/figure_api>
93+
Plotting methods <api/axes_api>
94+
95+
96+
.. grid-item::
97+
98+
Top-level interfaces to make:
99+
100+
- figures: `.pyplot.figure`
101+
- subplots: `.pyplot.subplots`, `.pyplot.subplot_mosaic`
102+
103+
104+
Ecosystem
105+
=========
106+
107+
.. grid:: 1 1 2 2
108+
:class-row: sd-align-minor-center
109+
110+
.. grid-item::
111+
112+
.. toctree::
113+
:maxdepth: 2
114+
115+
users/resources/index.rst
116+
117+
.. grid-item::
85118

86-
- Figures (`.pyplot.figure`)
87-
- Subplots (`.pyplot.subplots`, `.pyplot.subplot_mosaic`)
119+
:octicon:`link-external;1em;sd-text-info` `Third-party packages <https://matplotlib.org/mpl-third-party/>`_,
88120

121+
provide custom, domain specific, and experimental features, including
122+
styles, colors, more plot types and backends, and alternative
123+
interfaces.
89124

90-
********************
91-
Third-party packages
92-
********************
93125

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

98127

99-
************
100-
Contributing
101-
************
128+
About
129+
=====
130+
131+
.. grid:: 1 1 2 2
132+
:class-row: sd-align-minor-center
133+
134+
.. grid-item::
135+
136+
.. raw:: html
137+
138+
<div class="grid__intro" id="image_rotator"></div>
139+
140+
.. grid-item::
141+
142+
.. toctree::
143+
:maxdepth: 2
144+
145+
users/project/index.rst
146+
147+
148+
Contribute
149+
==========
150+
151+
.. grid:: 1 1 2 2
152+
:class-row: sd-align-minor-center
153+
154+
.. grid-item::
155+
156+
Matplotlib is a community project maintained for and by
157+
its users and contributions of all kinds are very appreciated.
158+
159+
.. grid-item::
160+
.. toctree::
161+
:maxdepth: 2
162+
163+
devel/index.rst
164+
165+
166+
Releases
167+
========
168+
169+
.. grid:: 1 1 2 2
170+
:class-row: sd-align-minor-center
171+
172+
.. grid-item::
173+
New versions are generally released every 6-8 months.
174+
New features and API changes are described in the release notes.
175+
176+
.. grid-item::
102177

103-
Matplotlib is a community project maintained for and by its users. There are many ways
104-
you can help!
178+
.. toctree::
179+
:maxdepth: 2
105180

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>`
181+
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.