DOC missing requirements for building documentation
See original GitHub issueThe instructions to build the documentation suggest,
For building the documentation, you will need sphinx, matplotlib and pillow.
yet numpydoc
also appear to be a requirement (tested on master
with Python 3.6 and sphinx 1.6.3),
make html [doc-version]
# These two lines make the build a bit more lengthy, and the
# the embedding of images more robust
rm -rf _build/html/_images
#rm -rf _build/doctrees/
sphinx-build -b html -d _build/doctrees . _build/html/stable
Running Sphinx v1.6.3
Extension error:
Could not import extension numpydoc (exception: No module named 'numpydoc')
make: *** [Makefile:42: html] Error 1
then if it’s installed,
Extension error:
Could not import extension sphinx_gallery.gen_gallery (exception: No module named 'sphinx_gallery.gen_gallery')
make: *** [Makefile:42: html] Error 1
If confirmed, numpydoc
and sphinx-gallery
requirements would need to be added to doc/developers/contributing.rst
and doc/README.md
.
Having e.g. a documentation_requrements.txt
somewhere with all the requirements to build the docs (one per line) could also be handy? It could be used from build_tools/circle/build_doc.sh
to install the requirements with pip or conda to avoid divergences between the documentation and the CI build in the future…
Issue Analytics
- State:
- Created 6 years ago
- Comments:5 (5 by maintainers)
Top Results From Across the Web
Missing documents in Project Management part 1 - Medium
Documents in Project Management: PM Project Charter. The need for documentation is the challenge of every Project Manager. Understanding the issues between ...
Read more >Mishaps and Misses: What a Missed Requirement Can Cost You
It's no secret that missed requirements can tank a project's budget, the GC's ROI, and the relationship between builder and client.
Read more >Docstrings are not included in Read the Docs Sphinx build
So the build passes, but the doc-strings are missing. Adding the extra dependencies will slow down the documentation builds because they all ...
Read more >Frequently Asked Questions - Read the Docs
For libraries that cannot be installed via apt in the builder there is another way to successfully build the documentation despite missing dependencies....
Read more >Build Better Requirements Documentation: Why, Who, and ...
Incomplete, inaccurate, or missed (don't forget non-existent) requirements increase the likelihood of a project failing to meet budget, ...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
I think that you need to add
matplotlib
to thedoc_requirements.txt
. If we go this way, I think that atest_requirements.txt
would be nice for pytest, nosetest, and the associated coverage …IMO, I like the way of the scikit-image fellow (https://github.com/scikit-image/scikit-image/tree/master/requirements) regarding the requirements organisation.
Fixed in https://github.com/scikit-learn/scikit-learn/pull/10225