Skip to content

Fix some readme bits #16671

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 8, 2020
Merged

Fix some readme bits #16671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
66efe2e
Use utf-8 when reading README for package description.
QuLogic Mar 5, 2020
db7492f
doc: Use https links in project readme.
QuLogic Mar 5, 2020
087c74f
doc: Use absolute links for readme images.
QuLogic Mar 5, 2020
95904d2
Fix undefined variable when using setup.py clean.
sandrotosi Mar 7, 2020
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
12 changes: 6 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@
.. _Downloads: https://pepy.tech/project/matplotlib/month

.. |NUMFocus| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
.. _NUMFocus: http://www.numfocus.org
.. _NUMFocus: https://www.numfocus.org

.. image:: doc/_static/logo2.png
.. image:: https://matplotlib.org/_static/logo2.svg

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

Check out our `home page <http://matplotlib.org/>`_ for more information.
Check out our `home page <https://matplotlib.org/>`_ for more information.

.. image:: doc/_static/readme_preview.png
.. image:: https://matplotlib.org/_static/readme_preview.png

Matplotlib produces publication-quality figures in a variety of hardcopy formats
and interactive environments across platforms. Matplotlib can be used in Python scripts,
Expand All @@ -58,7 +58,7 @@ Install
=======

For installation instructions and requirements, see `INSTALL.rst <INSTALL.rst>`_ or the
`install <http://matplotlib.org/users/installing.html>`_ documentation.
`install <https://matplotlib.org/users/installing.html>`_ documentation.

Test
====
Expand All @@ -77,7 +77,7 @@ You've worked out a way to fix it – even better!

You want to tell us about it – best of all!

Start at the `contributing guide <http://matplotlib.org/devdocs/devel/contributing.html>`_!
Start at the `contributing guide <https://matplotlib.org/devdocs/devel/contributing.html>`_!

Contact
=======
Expand Down
6 changes: 3 additions & 3 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,9 +223,9 @@ def run(self):
with open('lib/matplotlib/mpl-data/matplotlibrc', 'w') as fd:
fd.write(''.join(template_lines))

# Use Readme as long description
with open('README.rst') as fd:
long_description = fd.read()
# Use Readme as long description
with open('README.rst', encoding='utf-8') as fd:
long_description = fd.read()

# Finally, pass this all along to distutils to do the heavy lifting.
setup(
Expand Down