Bug 1034357
| Summary: | numpy missing doc module | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Tomas Tomecek <ttomecek> | ||||
| Component: | numpy | Assignee: | Gwyn Ciesla <gwync> | ||||
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Fedora Extras Quality Assurance <extras-qa> | ||||
| Severity: | unspecified | Docs Contact: | |||||
| Priority: | unspecified | ||||||
| Version: | rawhide | CC: | gwync, jkejda, jspaleta, orion, ovasik, rdieter, sochotni, tomspur, ttomecek | ||||
| Target Milestone: | --- | ||||||
| Target Release: | --- | ||||||
| Hardware: | Unspecified | ||||||
| OS: | Unspecified | ||||||
| Whiteboard: | |||||||
| Fixed In Version: | Doc Type: | Bug Fix | |||||
| Doc Text: | Story Points: | --- | |||||
| Clone Of: | 1032651 | Environment: | |||||
| Last Closed: | 2014-01-10 15:43:34 UTC | Type: | Bug | ||||
| Regression: | --- | Mount Type: | --- | ||||
| Documentation: | --- | CRM: | |||||
| Verified Versions: | Category: | --- | |||||
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |||||
| Cloudforms Team: | --- | Target Upstream Version: | |||||
| Embargoed: | |||||||
| Bug Depends On: | 1032651, 1051550, 1051553 | ||||||
| Bug Blocks: | |||||||
| Attachments: |
|
||||||
|
Description
Tomas Tomecek
2013-11-25 16:47:41 UTC
Looks like this has been this way since at least 0.9.4. Looks like sometime along the way, the doc/ directory became a module instead of a collection of text files. Test out 1.8.0-3 - that should have the doc module. As for the sphinx docs, that is failing with: $ make html mkdir -p build touch build/generate-stamp mkdir -p build/html build/doctrees LANG=C sphinx-build -b html -d build/doctrees source build/html Running Sphinx v1.1.3 1.8 1.8.0 NOTE: linkcode extension not found -- no links to source generated Looks like we are missing the sphinx.ext.linkcode module in Fedora You are right. But it seems that this dependency was added in numpy-1.8 because I can build documentation for 1.7 just fine:
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 637 warnings.
python postprocess.py html build/html/*.html
Build finished. The HTML pages are in build/html.
Although the number of warnings is quite alarming.
After some further investigation I can see that we have sphinx-1.1 in Fedora and the extension [1] is new in version 1.2 [2] and this version of sphinx is currently in beta [3]. So I guess that when sphinx-1.2 will be released we could give it a shot and try to build & package the documentation. [1] http://sphinx-doc.org/latest/ext/linkcode.html [2] http://sphinx-doc.org/latest/changes.html#id8 [3] http://sphinx-doc.org/latest/changes.html Created attachment 829362 [details]
patch to build sphinx documentation
I've managed to build the docs today, it took some time so I'm posting patch here so anyone else wouldn't have to spent time on it.
numpy-1.8.0-3.fc20 has been submitted as an update for Fedora 20. https://admin.fedoraproject.org/updates/numpy-1.8.0-3.fc20 Thanks Tomas. For now I've got the doc module in 1.8.0-3.fc20, and I'm building 1.7.1-7.fc19 with the doc module and the sphinx docs. I only am shipping the html dir - not sure if the doctrees and plot_directive dirs are useful - they do not seem to referenced by anything in html anyway. I wasn't sure either. I think that html dir will be sufficient (apart from that, whole built documentation has 80 MB, so shipping only 40 (the html dir) will be much better). Thanks for doing it Orion, great job! numpy-1.8.0-3.fc20 has been pushed to the Fedora 20 stable repository. If problems still persist, please make note of it in this bug report. Not sure why this didn't get closed. |