Move some advanced documentation away from Installation Guide #19505
Conversation
4fe0e14 to
ab5b489
Compare
| @@ -2,8 +2,8 @@ Increase minimum supported versions of Python and dependencies | |||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |||
|
|
|||
|
|
|||
| For Maptlotlib 3.4 the :ref:`minimum supported versions | |||
| <install_requirements>` are being bumped | |||
| For Maptlotlib 3.4 the :ref:`minimum supported versions <dependencies>` | |||
There was a problem hiding this comment.
So does this get manually updated on each new build? (Alt: for the latest release)
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Oh sorry I didn't look at the file name 😅 yeah it's fine then!
| Dependencies | ||
| ============ | ||
|
|
||
| Mandatory dependencies |
There was a problem hiding this comment.
| Mandatory dependencies | |
| Mandatory |
There was a problem hiding this comment.
Even though the whole page is about dependencies, IMHO it's slightly better to keep it explicit.
|
|
||
| .. _optional_dependencies: | ||
|
|
||
| Optional dependencies |
There was a problem hiding this comment.
| Optional dependencies | |
| Optional |
doc/devel/release_guide.rst
Outdated
| Conda packages | ||
| ============== | ||
|
|
||
| The conda packaging scripts for Matplotlib are hosted at |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Reworded.
Note also, that this is part of the release guide, which states at its top
6eb4271 to
8dd1092
Compare
|
@story645 thanks for reviewing! |
8dd1092 to
b505606
Compare
b505606 to
00112fa
Compare
|
@meeseeksdev backport to v3.4.x |
…rom Installation Guide
…505-on-v3.4.x Backport PR #19505 on branch v3.4.x (Move some advanced documentation away from Installation Guide)
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:
(*) 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.