Skip to content

Move some advanced documentation away from Installation Guide - #19505

Merged
story645 merged 2 commits into
matplotlib:masterfrom
timhoffm:doc-dependencies
Mar 17, 2021
Merged

story645 merged 2 commits into
matplotlib:masterfrom
timhoffm:doc-dependencies

Conversation

@timhoffm

@timhoffm timhoffm commented Feb 11, 2021 •

Copy link
Copy Markdown
Member

PR Summary

This is a first step for making the Installation Guide less intimidating. More than two screens of installation instructions is really scary, and the information moved within this PR is not needed by 99.999%* of our users.

For easier review, this PR is split in two commits:

  1. Move sections from INSTALL.rst:
    • Dependencies --> New section in devolopment guide (This is bulk copy&paste. The text is not modified.)
    • Conda packaging --> Release Guide
  2. Rewording and minor restructuring of dependencies

(*) Number based on ~10M downloads per month, and I'm quite sure less than less than 100 people per month install C libraries by hand or build conda packages.

@timhoffm timhoffm changed the title Doc dependencies Move some advanced documentation away from Installation Guide Feb 11, 2021
@timhoffm timhoffm mentioned this pull request Mar 16, 2021
6 tasks

For Maptlotlib 3.4 the :ref:`minimum supported versions
<install_requirements>` are being bumped
For Maptlotlib 3.4 the :ref:`minimum supported versions <dependencies>`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

So does this get manually updated on each new build? (Alt: for the latest release)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

What do you mean by "this"?

This is an API change note, which is specific to the release and does not need update.

The list of dependencies is manually maintained under the link below. It's manually maintained as before. I've only moved it to it's own section instead of having it hidden in the install docs.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Oh sorry I didn't look at the file name 😅 yeah it's fine then!

Comment thread doc/devel/dependencies.rst Resolved
Dependencies
============

Mandatory dependencies

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
Mandatory dependencies
Mandatory

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Even though the whole page is about dependencies, IMHO it's slightly better to keep it explicit.


.. _optional_dependencies:

Optional dependencies

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
Optional dependencies
Optional

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

As above.

Comment thread doc/devel/dependencies.rst Resolved
Comment thread doc/devel/dependencies.rst Resolved
Comment thread doc/devel/release_guide.rst Outdated
Conda packages
==============

The conda packaging scripts for Matplotlib are hosted at

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Even for the version distributed on the main conda channel?
I think a sentence about why this info could be useful (so it doesn't confuse folks who don't need to know) could be helpful here.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Reworded.

Note also, that this is part of the release guide, which states at its top

grafik

@timhoffm
timhoffm force-pushed the doc-dependencies branch 2 times, most recently from 6eb4271 to 8dd1092 Compare March 17, 2021 16:17
@timhoffm

Copy link
Copy Markdown
Member Author

@story645 thanks for reviewing!

@story645
story645 merged commit c2946de into matplotlib:master Mar 17, 2021
@timhoffm
timhoffm deleted the doc-dependencies branch March 17, 2021 20:14
@timhoffm

Copy link
Copy Markdown
Member Author

@meeseeksdev backport to v3.4.x

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Mar 17, 2021
@QuLogic QuLogic added this to the v3.4.0 milestone Mar 18, 2021
QuLogic added a commit that referenced this pull request Mar 18, 2021
…505-on-v3.4.x

Backport PR #19505 on branch v3.4.x (Move some advanced documentation away from Installation Guide)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants