Skip to content

DOCS: optional doc building dependencies #18610

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

Jump to bottom
Merged
merged 1 commit into from
Sep 30, 2020
Merged

DOCS: optional doc building dependencies #18610

merged 1 commit into from
Sep 30, 2020
+16 −7

Conversation

brunobeltran
Copy link
Contributor

PR Summary

Fixes #18355. tl;dr: You need Inkscape, optipng, and Humor Sans fonts installed locally for the docs to build without warnings.

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and pydocstyle<4 and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

QuLogic
QuLogic reviewed Sep 29, 2020
View reviewed changes
@brunobeltran brunobeltran force-pushed the install-docs-optional-deps branch from 56bc988 to b9ae76f Compare September 30, 2020 18:49
@brunobeltran
Copy link
Contributor Author

Thanks @QuLogic for catching the typos. Added Comic Neue as well.

Should be good to go.

@tacaswell tacaswell added this to the v3.4.0 milestone Sep 30, 2020
timhoffm
timhoffm approved these changes Sep 30, 2020
View reviewed changes
Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

Can be improved further. But will do in a follow up PR instead of going back and forth here.

@timhoffm timhoffm merged commit c5ab728 into matplotlib:master Sep 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuLogic QuLogic QuLogic left review comments

@story645 story645 story645 approved these changes

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.4.0
Development

Successfully merging this pull request may close these issues.

Optional components required to build docs aren't documented
6 participants
@brunobeltran @QuLogic @story645 @timhoffm @tacaswell @jklymak