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

Commit65a35ef

Browse files
committed
Backport PR#16626: Updated Readme + Setup.py for PyPa
Merge pull request#16626 from story645/readmeDOC/BLD: Updated Readme + Setup.py for PyPaConflicts:README.rst - implicitly backported several other changes to readme
1 parent5345ab7 commit65a35ef

File tree

4 files changed

+42
-48
lines changed

4 files changed

+42
-48
lines changed

‎.github/CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
Please refer to the[Coding
2-
Guidelines](http://matplotlib.org/devel/coding_guide.html).
1+
Please refer to the[developers guide](https://matplotlib.org/devel/index.html).

‎README.rst

Lines changed: 30 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -25,76 +25,68 @@
2525
.. |NUMFocus|image::https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
2626
.. _NUMFocus:http://www.numfocus.org
2727

28+
2829
.. |GitTutorial|image::https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?
2930
.. _GitTutorial:https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project
3031

31-
##########
32-
Matplotlib
33-
##########
32+
..image::doc/_static/logo2.png
3433

35-
Matplotlib is a Python 2D plotting library which produces publication-quality
36-
figures in a variety of hardcopy formats and interactive environments across
37-
platforms. Matplotlib can be used in Python scripts, the Python and IPython
38-
shell (à la MATLAB or Mathematica), web application servers, and various
39-
graphical user interface toolkits.
4034

41-
NOTE: The current master branch is now Python 3 only. Python 2 support is
42-
being dropped.
35+
Matplotlib is a comprehensive library for creating static, animated, and interactive visualizations in Python.
36+
37+
Check out our `home page<http://matplotlib.org/>`_ for more information.
38+
39+
..image::doc/_static/readme_preview.png
40+
41+
Matplotlib produces publication-quality figures in a variety of hardcopy formats
42+
and interactive environments across platforms. Matplotlib can be used in Python scripts,
43+
the Python and IPython shell, web application servers, and various
44+
graphical user interface toolkits.
4345

44-
`Home page<http://matplotlib.org/>`_
4546

4647
Install
4748
=======
4849

49-
For installation instructions and requirements, see the INSTALL.rst file or the
50-
`install<http://matplotlib.org/users/installing.html>`_ documentation. If you
51-
think you may want to contribute to matplotlib, check out the `guide to
52-
working with the source code
53-
<http://matplotlib.org/devel/gitwash/index.html>`_.
50+
For installation instructions and requirements, see `INSTALL.rst<INSTALL.rst>`_ or the
51+
`install<http://matplotlib.org/users/installing.html>`_ documentation.
5452

5553
Test
5654
====
5755

58-
After installation, you can launch the test suite::
56+
After installation, launch the test suite::
57+
58+
python -m pytest
5959

60-
pytest
60+
Read the `testing guide<https://matplotlib.org/devel/testing.html>`_ for more information and alternatives.
6161

62-
Or from the Python interpreter::
62+
Contribute
63+
==========
64+
You've discovered a bug or something else you want to change - excellent!
6365

64-
import matplotlib
65-
matplotlib.test()
66+
You've worked out a way to fix it – even better!
6667

67-
Consider reading http://matplotlib.org/devel/coding_guide.html#testing for more
68-
information. Note that the test suite requires pytest. Please install with pip
69-
or your package manager of choice.
68+
You want to tell us about it – best of all!
69+
70+
Start at the `contributing guide<http://matplotlib.org/devdocs/devel/contributing.html>`_!
7071

7172
Contact
7273
=======
73-
matplotlib's communication channels include active mailing lists:
74+
75+
`Discourse<https://discourse.matplotlib.org/>`_ is the discussion forum for general questions and discussions and our recommended starting point.
76+
77+
Our active mailing lists (which are mirrored on Discourse) are:
7478

7579
* `Users<https://mail.python.org/mailman/listinfo/matplotlib-users>`_ mailing list: matplotlib-users@python.org
7680
* `Announcement<https://mail.python.org/mailman/listinfo/matplotlib-announce>`_ mailing list: matplotlib-announce@python.org
7781
* `Development<https://mail.python.org/mailman/listinfo/matplotlib-devel>`_ mailing list: matplotlib-devel@python.org
7882

79-
The first is a good starting point for general questions and discussions.
80-
8183
Gitter_ is for coordinating development and asking questions directly related
8284
to contributing to matplotlib.
8385

84-
Contribute
85-
==========
86-
You've discovered a bug or something else you want to change - excellent!
87-
88-
You've worked out a way to fix it – even better!
89-
90-
You want to tell us about it – best of all!
91-
92-
Start at the `contributing guide<http://matplotlib.org/devdocs/devel/contributing.html>`_!
93-
94-
Developer notes are now at `Developer Discussions<https://github.com/orgs/matplotlib/teams/developers/discussions>`_ (Note: For technical reasons, this is currently only accessible for matplotlib developers.)
9586

9687
Citing Matplotlib
9788
=================
9889
If Matplotlib contributes to a project that leads to publication, please
9990
acknowledge this by citing Matplotlib.
91+
10092
`A ready-made citation entry<https://matplotlib.org/citing.html>`_ is available.

‎doc/_static/readme_preview.png

66.5 KB
Loading

‎setup.py

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@
7777
classifiers= [
7878
'Development Status :: 5 - Production/Stable',
7979
'Intended Audience :: Science/Research',
80+
'Intended Audience :: Education',
8081
'License :: OSI Approved :: Python Software Foundation License',
8182
'Programming Language :: Python',
8283
'Programming Language :: Python :: 3',
@@ -222,6 +223,10 @@ def run(self):
222223
withopen('lib/matplotlib/mpl-data/matplotlibrc','w')asfd:
223224
fd.write(''.join(template_lines))
224225

226+
# Use Readme as long description
227+
withopen('README.rst')asfd:
228+
long_description=fd.read()
229+
225230
# Finally, pass this all along to distutils to do the heavy lifting.
226231
setup(
227232
name="matplotlib",
@@ -232,16 +237,14 @@ def run(self):
232237
url="https://matplotlib.org",
233238
download_url="https://matplotlib.org/users/installing.html",
234239
project_urls={
240+
'Documentation':'https://matplotlib.org',
241+
'Source Code':'https://github.com/matplotlib/matplotlib',
235242
'Bug Tracker':'https://github.com/matplotlib/matplotlib/issues',
236-
'Documentation':'https://matplotlib.org/contents.html',
237-
'Source Code':'https://github.com/matplotlib/matplotlib'
243+
'Forum':'https://discourse.matplotlib.org/',
244+
'Donate':'https://numfocus.org/donate-to-matplotlib'
238245
},
239-
long_description="""
240-
Matplotlib strives to produce publication quality 2D graphics
241-
for interactive graphing, scientific publishing, user interface
242-
development and web application servers targeting multiple user
243-
interfaces and hardcopy output formats.
244-
""",
246+
long_description=long_description,
247+
long_description_content_type="text/x-rst",
245248
license="PSF",
246249
platforms="any",
247250
package_dir={"":"lib"},

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp