DOC: Clearer wording for the installation of external dependencies #29405
Conversation
|
In general I think external tools is ill defined (b/c it can be system tools, apps, libraries, etc) and that's why all the docs around external tools are clunky. |
I've stumbled over this when reading the instructions. While this is in the section "Install external dependencies", I was unclear whether that link would go to / cover the whole doc dependencies. Stating that these are only the "external tools for the documentation build" is a bit clearer.
I have the feeling that "external" is not a good term here - external to what? - and what would be "internal". Maybe "non-Python tools" would be a better term? |
|
As far as I remember, it's the set of things that can't/shouldn't be conda/pip installed. |
|
Reading the relevant sections again https://matplotlib.org/devdocs/devel/development_setup.html#install-external-dependencies and I’m ok with how “external “ is used. This PR is in line with our current use of that terminology. If you want to fundamentally bike-shed that terminology, please open a separate issue/PR. |
I've stumbled over this when reading the instructions. While this is in the section "Install external dependencies", I was unclear whether that link would go to / cover the whole doc dependencies. Stating that these are only the "external tools for the documentation build" is a bit clearer.