Skip to content

Optional components required to build docs aren't documented #18355

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
Closed
brunobeltran opened this issue Aug 25, 2020 · 1 comment · Fixed by #18610
Closed

Optional components required to build docs aren't documented #18355

brunobeltran opened this issue Aug 25, 2020 · 1 comment · Fixed by #18610
Assignees
@brunobeltran
Labels
Documentation
Milestone
v3.4.0

Comments

@brunobeltran
Copy link
Contributor

brunobeltran commented Aug 25, 2020 •
edited
Loading

Problem

Some optional components are required to get the docs building without warnings. AFAICT, these are not mentioned in the dev docs. These include:

  1. Inkscape
WARNING: Inkscape command 'inkscape' cannot be run. Check the inkscape_converter_bin setting
  1. Fonts
findfont: Font family ['xkcd', 'xkcd Script', 'Humor Sans', 'Comic Neue', 'Comic Sans MS'] not found. Falling back to DejaVu Sans.
  1. Optipng
WARNING: optipng binaries not found, PNG thumbnails and images will not be optimized

Suggested Improvement

Once @jeromefv confirms that I'm not missing anything, I can make a PR to update the docs to contain all this information. They probably don't need to be front and center, since the docs build just fine without these (except maybe Inkscape?) But it'd be nice to have an "optional dependencies" note.
@brunobeltran brunobeltran self-assigned this Aug 25, 2020
@brunobeltran
Copy link
Contributor Author

@jeromefv, if you find any other issues with what needs to be installed before getting the docs to build, feel free to mention them here and I'll add it to the docs!

@brunobeltran brunobeltran mentioned this issue Sep 29, 2020
Merged
7 tasks
@QuLogic QuLogic added this to the v3.4.0 milestone Sep 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@brunobeltran brunobeltran

Labels
Documentation
Projects
None yet
Milestone
v3.4.0
Development

Successfully merging a pull request may close this issue.

DOCS: optional doc building dependencies brunobeltran/matplotlib
2 participants
@QuLogic @brunobeltran