8000 DOC: fill out dev docs by mattip · Pull Request #9378 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content
8000

DOC: fill out dev docs #9378

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 6 commits into from
Oct 18, 2017
Merged

DOC: fill out dev docs #9378

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
60e9feb
fill out dev docs
mattip Oct 12, 2017
1bf4450
document alternative to automatic download
mattip Oct 12, 2017
753bed2
fixes from reviewers, failed CI, reshuffle FreeType section
mattip Oct 16, 2017
df0cdd0
remove unneeded link
mattip Oct 16, 2017
680f178
matplotlib to Matplotlib
mattip Oct 17, 2017
c856d0c
add ..ing
mattip Oct 17, 2017
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
8 changes: 8 additions & 0 deletions doc/devel/testing.rst
View file
Open in desktop
Original file line number Diff line number Diff line c 10000 hange
Expand Up @@ -8,6 +8,7 @@ Matplotlib's testing infrastructure depends on pytest_. The tests are in
:file:`lib/matplotlib/tests`, and customizations to the pytest testing
infrastructure are in :mod:`matplotlib.testing`.

.. _dependencies: http://matplotlib.org/users/installing.html#dependencies
Copy link
Member

Choose a reason for hiding this comment

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

This should be a Sphinx cross-references and not http://matplotlib.org/...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

how do I do that to a particular anchor in the page, i.e. dependencies on the installing page?

Copy link
Member
@QuLogic QuLogic Oct 15, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

You'd need to add a tag before the heading, but fortunately, there's already one there: install_requirements. You can use that name in the cross-reference instead of dependencies.

(This may be a bit difficult to find because doc/users/installing.html actually comes from INSTALL.rst in the top-level.)

Copy link
Member

Choose a reason for hiding this comment

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

So this change is not needed any more?

.. _pytest: http://doc.pytest.org/en/latest/
.. _mock: https://docs.python.org/3/library/unittest.mock.html>
.. _Ghostscript: https://www.ghostscript.com/
Expand All @@ -20,6 +21,13 @@ infrastructure are in :mod:`matplotlib.testing`.
Requirements
------------

We strongly recommend developing new features in a seperate virtualenv.

Install all the matplotlib dependencies_, and install matplotlib into the
Copy link
Member

Choose a reason for hiding this comment

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

"Matplotlib" should always be uppercase in the text.

virtualenv with ``pip install -e matplotlib`` (but note the changes needed to
Copy link
Member

Choose a reason for hiding this comment

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

OK, this isn't really my workflow. If you are developing, you need to pull down master from GitHub and pip install -e . from the GitHub directory. I also think that @anntzer just had a PR like this, or at least one that explicitly said how to pip install.

Copy link
Member

Choose a reason for hiding this comment

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

See #9291 and use of python -mpip install -e .

``setup.cfg`` below) which will allow you to edit the code without
reinstalling.
Copy link
Member

Choose a reason for hiding this comment

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

I still think this is repeating what's in devel/contributing.rst. I think we should avoid duplicating instructions. If you haven't already installed the development version of Matplotlib then testing doesn't make a lot of sense.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would just write "Install the latest version of Matplotlib as documented in http://matplotlib.org/devdocs/devel/contributing.html#retrieving-and-installing-the-latest-version-of-the-code. In particular, follow the instructions to use a local FreeType build." (fix the link, of course). And then remove the mention of localfreetype below.

(We also print a warning when tests are done on a nonlocal freetype version so I think that's enough.)


The following software is required to run the tests:

- pytest_, version 3.0.0 or later
Expand Down
0