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

Skip to content

Commit 7b5327b

Browse files
timhoffmtimhoffm
authored
Merge pull request matplotlib#26332 from story645/doc-root
moved doc root to landing page, make user landing a guide page
2 parents f7a8cab + 13908c4 commit 7b5327b

File tree

6 files changed

+229
-212
lines changed

6 files changed

+229
-212
lines changed

‎doc/conf.py‎

Lines 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‎

Lines 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‎

Lines changed: 119 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,169 @@
97
Matplotlib |release| documentation
108
##################################
119

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

15-
************
16-
Installation
17-
************
14+
Install
15+
=======
1816

19-
.. grid:: 1 1 2 2
17+
.. tab-set::
18+
:class: sd-width-content-min
2019

21-
.. grid-item::
22-
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
3833

34+
.. toctree::
35+
:maxdepth: 2
3936

40-
******************
41-
Learning resources
42-
******************
37+
users/installing/index
38+
39+
For more detailed instructions, see the
40+
:doc:`installation guide <users/installing/index>`.
41+
42+
Learn
43+
=====
4344

4445
.. grid:: 1 1 2 2
4546

4647
.. grid-item-card::
4748
:padding: 2
49+
:columns: 6
4850

49-
Tutorials
51+
**How to use Matplotlib?**
5052
^^^
53+
.. toctree::
54+
:maxdepth: 1
5155

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>`
56+
users/explain/quick_start
57+
User guide <users/index.rst>
58+
tutorials/index.rst
59+
users/faq/index.rst
5660

5761
.. grid-item-card::
5862
:padding: 2
63+
:columns: 6
5964

60-
How-tos
65+
**What can Matplotlib do?**
6166
^^^
67+
.. toctree::
68+
:maxdepth: 1
69+
70+
plot_types/index.rst
71+
gallery/index.rst
6272

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

6674
.. grid-item-card::
6775
:padding: 2
76+
:columns: 12
6877

69-
Understand how Matplotlib works
78+
**Reference**
7079
^^^
7180

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

75-
.. grid-item-card::
76-
:padding: 2
84+
.. grid-item::
7785

78-
Reference
79-
^^^
86+
.. toctree::
87+
:maxdepth: 1
8088

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:
89+
API reference <api/index>
90+
Figure methods <api/figure_api>
91+
Plotting methods <api/axes_api>
8592

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

94+
.. grid-item::
8995

90-
********************
91-
Third-party packages
92-
********************
96+
Top-level interfaces to create:
9397

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

101+
Community
102+
=========
103+
104+
.. grid:: 1 1 2 2
105+
:class-row: sd-align-minor-center
106+
107+
.. grid-item::
108+
109+
.. toctree::
110+
:maxdepth: 2
111+
112+
users/resources/index.rst
113+
114+
.. grid-item::
115+
116+
:octicon:`link-external;1em;sd-text-info` `Third-party packages <https://matplotlib.org/mpl-third-party/>`_,
117+
118+
provide custom, domain specific, and experimental features, including
119+
styles, colors, more plot types and backends, and alternative
120+
interfaces.
121+
122+
What's new
123+
==========
124+
125+
.. grid:: 1 1 2 2
98126

99-
************
100-
Contributing
101-
************
127+
.. grid-item::
128+
129+
Learn about new features and API changes.
130+
131+
.. grid-item::
132+
133+
.. toctree::
134+
:maxdepth: 1
135+
136+
users/release_notes.rst
137+
138+
139+
Contribute
140+
==========
141+
142+
.. grid:: 1 1 2 2
143+
:class-row: sd-align-minor-center
144+
145+
.. grid-item::
146+
147+
Matplotlib is a community project maintained for and by its users.
148+
149+
There are many ways you can help!
150+
151+
.. grid-item::
152+
.. toctree::
153+
:maxdepth: 2
154+
155+
devel/index.rst
156+
157+
About us
158+
========
159+
160+
.. grid:: 1 1 2 2
161+
:class-row: sd-align-minor-center
162+
163+
.. grid-item::
164+
165+
Matplotlib was created by neurobiologist John Hunter to work with EEG
166+
data. It grew to be used and developed by many people in many
167+
different fields. John's goal was that Matplotlib make easy things easy
168+
and hard things possible.
169+
170+
.. grid-item::
102171

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

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>`
175+
users/project/index.rst

0 commit comments

Comments
 (0)