NotificationsYou must be signed in to change notification settings
Fork8.1k
Star22.1k

Commit13908c4

committed

old landing page sections + install/contribute/project/release from users

+ moved users index a level up

1 parent22fd053 commit13908c4Copy full SHA for 13908c4

File tree

6 files changed

+229

-212

lines changed

doc
- conf.py
- devel
  - index.rst
- index.rst
- users
  - index.rst
galleries
- tutorials
  - index.rst
- users_explain
  - index.rst

6 files changed

+229

-212

lines changed

`‎doc/conf.py‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -311,7 +311,7 @@ def gallery_image_warning_filter(record):`
`311`	`311`	`source_encoding="utf-8"`
`312`	`312`
`313`	`313`	`# 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'`
`315`	`315`
`316`	`316`	`# General substitutions.`
`317`	`317`	`try:`

`‎doc/devel/index.rst‎`

Lines changed: 33 additions & 11 deletions

Original file line number	Diff line number	Diff line change
`@@ -9,13 +9,16 @@ ways to contribute: optimizing and refactoring code, detailing unclear`
`9`	`9`	`documentation and writing new examples, reporting and fixing bugs and requesting`
`10`	`10`	`and implementing new features, helping the community...`
`11`	`11`
	`12`	`+New contributors`
	`13`	`+================`
	`14`	`+`
`12`	`15`	`..card::`
`13`	`16`
`14`	`17`	`..grid::1 1 2 2`
	`18`	`+:class-row: sd-align-minor-center`
`15`	`19`
`16`	`20`	`..grid-item::`
`17`	`21`	`:class: sd-fs-5`
`18`		`-:child-align: spaced`
`19`	`22`
`20`	`23`	:octicon:`info;1em;sd-text-info`:ref:`Where should I start?<start-contributing>`
`21`	`24`
`@@ -67,12 +70,15 @@ For code, documentation, or triage, please follow the corresponding`
`67`	`70`
`68`	`71`	`.. _development_environment:`
`69`	`72`
`70`		`-Developmentworkflow`
`71`		`-====================`
	`73`	`+Developmentenvironment`
	`74`	`+=======================`
`72`	`75`
`73`	`76`	`..grid::1 1 2 2`
`74`	`77`
`75`		`- ..grid-item-card::Install`
	`78`	`+ ..grid-item-card::`
	`79`	`+`
	`80`	`+ Install`
	`81`	`+ ^^^`
`76`	`82`
`77`	`83`	`..toctree::`
`78`	`84`	`:maxdepth:2`
`@@ -85,7 +91,10 @@ Development workflow`
`85`	`91`	`dependencies`
`86`	`92`
`87`	`93`
`88`		`- ..grid-item-card::Workflow`
	`94`	`+ ..grid-item-card::`
	`95`	`+`
	`96`	`+ Workflow`
	`97`	`+ ^^^^`
`89`	`98`
`90`	`99`	`..toctree::`
`91`	`100`	`:maxdepth:2`
`@@ -96,13 +105,17 @@ Development workflow`
`96`	`105`
`97`	`106`	`.. _contribution_guideline:`
`98`	`107`
`99`		`-Contribution guides`
`100`		`-===================`
	`108`	`+Policies and guidelines`
	`109`	`+=======================`
`101`	`110`
`102`	`111`	`..grid::1 1 2 2`
`103`	`112`	`:class-row: sf-fs-1`
	`113`	`+:gutter: 2`
	`114`	`+`
	`115`	`+ ..grid-item-card::`
`104`	`116`
`105`		`- ..grid-item-card::Code`
	`117`	`+ Code`
	`118`	`+ ^^^`
`106`	`119`
`107`	`120`	\|:ref:`coding_guidelines`
`108`	`121`
`@@ -112,21 +125,30 @@ Contribution guides`
`112`	`125`	`coding_guide`
`113`	`126`	`testing`
`114`	`127`
`115`		`- ..grid-item-card::Documentation`
	`128`	`+ ..grid-item-card::`
	`129`	`+`
	`130`	`+ Documentation`
	`131`	`+ ^^^`
`116`	`132`
`117`	`133`	`..toctree::`
`118`	`134`	`:maxdepth:1`
`119`	`135`
`120`	`136`	`document`
`121`	`137`	`style_guide`
`122`	`138`
`123`		`- ..grid-item-card::Triage`
	`139`	`+ ..grid-item-card::`
	`140`	`+`
	`141`	`+ Triage`
	`142`	`+ ^^^`
`124`	`143`
`125`	`144`	\|:ref:`bug_triaging`
`126`	`145`	\|:ref:`triage_team`
`127`	`146`	\|:ref:`triage_workflow`
`128`	`147`
`129`		`- ..grid-item-card::Maintenance`
	`148`	`+ ..grid-item-card::`
	`149`	`+`
	`150`	`+ Maintenance`
	`151`	`+ ^^^`
`130`	`152`
`131`	`153`	`..toctree::`
`132`	`154`	`:maxdepth:1`

`‎doc/index.rst‎`

Lines changed: 119 additions & 52 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-:orphan:`
`2`		`-`
`3`	`1`	`..title::Matplotlib documentation`
`4`	`2`
`5`	`3`	`..module::matplotlib`
`@@ -9,100 +7,169 @@`
`9`	`7`	`Matplotlib \|release\| documentation`
`10`	`8`	`##################################`
`11`	`9`
	`10`	`+`
`12`	`11`	`Matplotlib is a comprehensive library for creating static, animated,`
`13`		`-and interactive visualizations in Python.`
	`12`	`+and interactive visualizations.`
`14`	`13`
`15`		`-************`
`16`		`-Installation`
`17`		`-************`
	`14`	`+Install`
	`15`	`+=======`
`18`	`16`
`19`		`-..grid::1 1 2 2`
	`17`	`+..tab-set::`
	`18`	`+:class: sd-width-content-min`
`20`	`19`
`21`		`- ..grid-item::`
`22`		`-`
`23`		- Install using `pip<https://pypi.org/project/matplotlib>`__:
	`20`	`+ ..tab-item::pip`
`24`	`21`
`25`	`22`	`..code-block::bash`
`26`	`23`
`27`	`24`	`pip install matplotlib`
`28`	`25`
`29`		`- ..grid-item::`
`30`		`-`
`31`		- Install using `conda<https://docs.continuum.io/anaconda/>`__:
	`26`	`+ ..tab-item::conda`
`32`	`27`
`33`	`28`	`..code-block::bash`
`34`	`29`
`35`	`30`	`conda install -c conda-forge matplotlib`
`36`	`31`
`37`		-Further details are available in the:doc:`Installation Guide<users/installing/index>`.
	`32`	`+ ..tab-item::other`
`38`	`33`
	`34`	`+ ..toctree::`
	`35`	`+:maxdepth:2`
`39`	`36`
`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`	`+=====`
`43`	`44`
`44`	`45`	`..grid::1 1 2 2`
`45`	`46`
`46`	`47`	`..grid-item-card::`
`47`	`48`	`:padding: 2`
	`49`	`+:columns: 6`
`48`	`50`
`49`		`-Tutorials`
	`51`	`+How to use Matplotlib?`
`50`	`52`	`^^^`
	`53`	`+ ..toctree::`
	`54`	`+:maxdepth:1`
`51`	`55`
`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`
`56`	`60`
`57`	`61`	`..grid-item-card::`
`58`	`62`	`:padding: 2`
	`63`	`+:columns: 6`
`59`	`64`
`60`		`-How-tos`
	`65`	`+What can Matplotlib do?`
`61`	`66`	`^^^`
	`67`	`+ ..toctree::`
	`68`	`+:maxdepth:1`
	`69`	`+`
	`70`	`+plot_types/index.rst`
	`71`	`+gallery/index.rst`
`62`	`72`
`63`		- -:doc:`Example gallery<gallery/index>`
`64`		- -:doc:`Matplotlib FAQ<users/faq/index>`
`65`	`73`
`66`	`74`	`..grid-item-card::`
`67`	`75`	`:padding: 2`
	`76`	`+:columns: 12`
`68`	`77`
`69`		`-Understand how Matplotlib works`
	`78`	`+Reference`
`70`	`79`	`^^^`
`71`	`80`
`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`
`74`	`83`
`75`		`- ..grid-item-card::`
`76`		`-:padding: 2`
	`84`	`+ ..grid-item::`
`77`	`85`
`78`		`-Reference`
`79`		`-^^^`
	`86`	`+ ..toctree::`
	`87`	`+:maxdepth:1`
`80`	`88`
`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>`
`85`	`92`
`86`		- - Figures (`.pyplot.figure`)
`87`		- - Subplots (`.pyplot.subplots`, `.pyplot.subplot_mosaic`)
`88`	`93`
	`94`	`+ ..grid-item::`
`89`	`95`
`90`		`-********************`
`91`		`-Third-party packages`
`92`		`-********************`
	`96`	`+ Top-level interfaces to create:`
`93`	`97`
`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`
`97`	`100`
	`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`
`98`	`126`
`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::`
`102`	`171`
`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`
`105`	`174`
`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)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit13908c4

File tree

6 files changed

6 files changed

`‎doc/conf.py‎`

`‎doc/devel/index.rst‎`

`‎doc/index.rst‎`

0 commit comments