Movatterモバイル変換

[0]ホーム
URL:

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

 Sign up
Appearance settings

"inner" index reorganization#20867

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
timhoffm merged 3 commits intomatplotlib:masterfromtacaswell:doc_index_reorg
Sep 12, 2021
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
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.github/FUNDING.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
# These are supported funding model platforms
github: [numfocus]
github: [matplotlib,numfocus]
custom: https://numfocus.org/donate-to-matplotlib
8 changes: 8 additions & 0 deletionsdoc/_static/mpl.css
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -212,3 +212,11 @@ table.property-table th,
table.property-table td {
padding: 4px 10px;
}

.donate-button {
margin: 1em 0;
}

.sphinxsidebarwrapper {
margin: 0 1em;
}
9 changes: 9 additions & 0 deletionsdoc/_templates/cheatsheet_sidebar.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@

<div class="sphinxsidebarwrapper">
<h3>Matplotlib cheatsheets</h3>
<a href="https://github.com/matplotlib/cheatsheets#cheatsheets">
<img src="_static/mpl_cheatsheet1.png"
alt="Matplotlib cheatsheets"
srcset="_static/mpl_cheatsheet1.png 1x, _static/mpl_cheatsheet1_2x.png 2x"/>
</a>
</div>
6 changes: 4 additions & 2 deletionsdoc/_templates/donate_sidebar.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@



<div id="sidebar-donations">
<a href="https://numfocus.org/donate-to-matplotlib" target="_blank"> <span class="mpl-button donate_button" >Support Matplotlib</span></a>
<div id="sidebar-donations" class="donate-button">
<a href="https://numfocus.org/donate-to-matplotlib" target="_blank">
<span class="mpl-button" >Support Matplotlib</span>
</a>
</div>
24 changes: 24 additions & 0 deletionsdoc/_templates/mpl_nav_bar.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
<ul id="navbar-main-elements" class="navbar-nav">

<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('plot_types/index') }}">Plot Types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('gallery/index') }}">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('tutorials/index') }}">Tutoraials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('api/index') }}">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('contents') }}">Usage Guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('devel/index') }}">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('users/release_notes') }}">Release Notes</a>
</li>
</ul>
9 changes: 0 additions & 9 deletionsdoc/_templates/sidebar_versions.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,12 +36,3 @@
getSnippet('other_versions', '/versions.html');
</script>
</div>

<div class="sphinxsidebarwrapper">
<h3>Matplotlib cheatsheets</h3>
<a href="https://github.com/matplotlib/cheatsheets#cheatsheets">
<img src="_static/mpl_cheatsheet1.png"
alt="Matplotlib cheatsheets"
srcset="_static/mpl_cheatsheet1.png 1x, _static/mpl_cheatsheet1_2x.png 2x"/>
</a>
</div>
8 changes: 7 additions & 1 deletiondoc/conf.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,12 +71,15 @@
'sphinxext.skip_deprecated',
'sphinxext.redirect_from',
'sphinx_copybutton',
'sphinx_panels',
]

exclude_patterns = [
'api/prev_api_changes/api_changes_*/*',
]

panels_add_bootstrap_css = False


def _check_dependencies():
names = {
Expand DownExpand Up@@ -312,8 +315,9 @@ def _check_dependencies():
"url": "https://twitter.com/matplotlib/",
"icon": "fab fa-twitter-square",
},

],
"show_prev_next": False,
"navbar_center": ["mpl_nav_bar.html"],
}
include_analytics = False
if include_analytics:
Expand DownExpand Up@@ -341,8 +345,10 @@ def _check_dependencies():
# Custom sidebar templates, maps page names to templates.
html_sidebars = {
"index": [
'search-field.html',
# 'sidebar_announcement.html',
"sidebar_versions.html",
"cheatsheet_sidebar.html",
"donate_sidebar.html",
],
# '**': ['localtoc.html', 'pagesource.html']
Expand Down
9 changes: 3 additions & 6 deletionsdoc/contents.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@

.. _complete_sitemap:

Contents
========
Expand All@@ -15,13 +15,10 @@ Contents
:maxdepth: 2

users/installing.rst
plot_types/index.rst
gallery/index.rst
tutorials/index.rst
api/index.rst
users/index.rst
users/backmatter.rst
devel/index.rst
Third-party packages <https://matplotlib.org/mpl-third-party/>
users/release_notes.rst

.. only:: html

Expand Down
6 changes: 3 additions & 3 deletionsdoc/faq/index.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
.. _faq-index:

##################
The Matplotlib FAQ
##################
######
How-to
######

.. only:: html

Expand Down
122 changes: 95 additions & 27 deletionsdoc/index.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,41 +4,109 @@

.. module:: matplotlib

Matplotlib documentation
------------------------

Release: |release|
Matplotlib |release| documentation
----------------------------------

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

Learn
=====

- :doc:`Quick-start Guide <tutorials/introductory/usage>`
- Basic :doc:`Plot Types <plot_types/index>` and :doc:`Example Gallery <gallery/index>`
- `Introductory Tutorials <../tutorials/index.html#introductory>`_
- :doc:`External Learning Resources <resources/index>`

Reference
=========
Installation
============

- :doc:`API Reference <api/index>`
.. panels::
:card: + install-card
:column: col-lg-6 col-md-6 col-sm-12 col-xs-12 p-3

- :doc:`pyplot API <api/pyplot_summary>`: top-level interface to create
Figures (`.pyplot.figure`) and Subplots (`.pyplot.subplots`,
`.pyplot.subplot_mosaic`)
- :doc:`Axes API <api/axes_api>` for *most* plotting methods
- :doc:`Figure API <api/figure_api>` for figure-level methods
Installing using `conda <https://docs.continuum.io/anaconda/>`__
^^^^^^^^^^^^^^^^^^^^^^

How-tos
=======

- :doc:`Installation Guide <users/installing>`
- :doc:`Contributing to Matplotlib <devel/index>`
- :doc:`Matplotlib FAQ <faq/index>`

Understand how Matplotlib works
===============================
.. code-block:: bash

- Many of the :doc:`Tutorials <tutorials/index>` have explanatory material
conda install matplotlib

---

Installing using `pip <https://pypi.org/project/matplotlib>`__
^^^^^^^^^^^^^^^^^^^^


.. code-block:: bash

pip install matplotlib


Further details are available in the :doc:`Installation Guide <users/installing>`.


Learning resources
==================


.. panels::

Tutorials
^^^^^^^^^

- :doc:`Quick-start Guide <tutorials/introductory/usage>`
- :doc:`Plot Types <plot_types/index>`
- `Introductory Tutorials <../tutorials/index.html#introductory>`_
- :doc:`External Learning Resources <resources/index>`

---

How-tos
^^^^^^^
- :doc:`Example Gallery <gallery/index>`
- :doc:`Matplotlib FAQ <faq/index>`

---

Understand how Matplotlib works
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- The :ref:`users-guide-explain` section of the :doc:`Users guide <users/index>`
- Many of the :ref:`Intermediate <tutorials-intermediate>` and
:ref:`Advanced <tutorials-advanced>` Tutorials
have explanatory material

---

Reference
^^^^^^^^^

- :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:

- Figures (`.pyplot.figure`)
- Subplots (`.pyplot.subplots`, `.pyplot.subplot_mosaic`)
Comment on lines +81 to +86
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Maybe this should be a sublist because these are all underapi/index. But not sure how it renders...

Suggested change
-: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:
- Figures (`.pyplot.figure`)
- Subplots (`.pyplot.subplots`, `.pyplot.subplot_mosaic`)
-: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:
- Figures (`.pyplot.figure`)
- Subplots (`.pyplot.subplots`, `.pyplot.subplot_mosaic`)

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I'm going to hold off on this one as if everythingbut one is in the second sub-list we should find some other way to structure this.

jklymak reacted with thumbs up emoji



Third-party packages
--------------------

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


Contributing
------------

Matplotlib is a community project maitained for and by its users. There are many ways
you can help!

- 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>`


Site map
--------

The :ref:`complete contents of the docs <complete_sitemap>`.
11 changes: 11 additions & 0 deletionsdoc/users/backmatter.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@

Project Information
-------------------

.. toctree::
:maxdepth: 1

license.rst
../citing.rst
credits.rst
history.rst
10 changes: 10 additions & 0 deletionsdoc/users/explain.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
.. _users-guide-explain:

Explanations
------------

.. toctree::
:maxdepth: 1

interactive.rst
fonts.rst
8 changes: 4 additions & 4 deletionsdoc/users/fonts.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
Fonts in MatplotlibText Engine
Fonts in Matplotlibtext engine
===============================

Matplotlib needs fonts to work with its text engine, some of which are shipped
alongside the installation. However, users can configure the default fonts, or
even provide their own custom fonts! For more details, see :doc:`Customizing
even provide their own custom fonts! For more details, see :doc:`Customizing
text properties </tutorials/text/text_props>`.

However, Matplotlib also provides an option to offload text rendering to a TeX
engine (``usetex=True``),
see :doc:`Text rendering with LaTeX </tutorials/text/usetex>`.

FontSpecifications
Fontspecifications
-------------------
Fonts have a long and sometimes incompatible history in computing, leading to
different platforms supporting different types of fonts. In practice, there are
Expand DownExpand Up@@ -40,7 +40,7 @@ fonts', more about which is explained later in the guide):
NOTE: Adobe will disable support for authoring with Type 1 fonts in
January 2023. `Read more here. <https://helpx.adobe.com/fonts/kb/postscript-type-1-fonts-end-of-support.html>`_

SpecialMentions
Specialmentions
^^^^^^^^^^^^^^^^
Other font specifications which Matplotlib supports:

Expand Down
29 changes: 15 additions & 14 deletionsdoc/users/index.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
.. _users-guide-index:

############
User's guide
############
###########
Usage Guide
###########

.. only:: html

:Release: |version|
:Date: |today|




.. toctree::
:maxdepth: 2

interactive.rst
fonts.rst
release_notes.rst
license.rst
../citing.rst
../resources/index.rst
../faq/index.rst
credits.rst
history.rst
:maxdepth: 2

../plot_types/index.rst
../tutorials/index.rst
../gallery/index.rst
explain.rst
../faq/index.rst
../api/index.rst
../resources/index.rst
Binary file addedexamples/user_interfaces/test.bmp
View file
Open in desktop
Binary file not shown.
7 changes: 4 additions & 3 deletionsrequirements/doc/doc-requirements.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,12 +12,13 @@ colorspacious
ipython
ipywidgets
numpydoc>=0.8
pydata-sphinx-theme>=0.5.0
pydata-sphinx-theme>=0.6.0
sphinxcontrib-svg2pdfconverter>=1.1.0
# sphinx-gallery>=0.7
# b41e328 is PR 808 which adds the image_srcset directive. When this is
# sphinx-gallery>=0.7
# b41e328 is PR 808 which adds the image_srcset directive. When this is
# released with sphinx gallery, we can change to the last release w/o this feature:
# sphinx-gallery>0.90
git+git://github.com/sphinx-gallery/sphinx-gallery@b41e328#egg=sphinx-gallery
sphinx-copybutton
sphinx-panels
scipy
[8]ページ先頭
©2009-2025 Movatter.jp