Bug 850551
| Summary: | Sphinx manpage generation is broken with the new docutils package | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Toshio Ernie Kuratomi <a.badger> | ||||
| Component: | python-sphinx | Assignee: | Michel Lind <michel> | ||||
| Status: | CLOSED ERRATA | QA Contact: | Fedora Extras Quality Assurance <extras-qa> | ||||
| Severity: | unspecified | Docs Contact: | |||||
| Priority: | unspecified | ||||||
| Version: | rawhide | CC: | a.badger, lmacken, michel | ||||
| Target Milestone: | --- | ||||||
| Target Release: | --- | ||||||
| Hardware: | Unspecified | ||||||
| OS: | Unspecified | ||||||
| Whiteboard: | |||||||
| Fixed In Version: | Doc Type: | Bug Fix | |||||
| Doc Text: | Story Points: | --- | |||||
| Clone Of: | Environment: | ||||||
| Last Closed: | 2012-09-17 22:25:37 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: | |||||||
| Attachments: |
|
||||||
I tested the patch locally and it fixes the issue that I'm seeing the with building pyrasite's docs on F18 and newer. python-sphinx-1.1.3-5.fc18 has been submitted as an update for Fedora 18. https://admin.fedoraproject.org/updates/python-sphinx-1.1.3-5.fc18 Package python-sphinx-1.1.3-5.fc18: * should fix your issue, * was pushed to the Fedora 18 testing repository, * should be available at your local mirror within two days. Update it with: # su -c 'yum update --enablerepo=updates-testing python-sphinx-1.1.3-5.fc18' as soon as you are able to. Please go to the following url: https://admin.fedoraproject.org/updates/FEDORA-2012-12707/python-sphinx-1.1.3-5.fc18 then log in and leave karma (feedback). python-sphinx-1.1.3-5.fc18 has been pushed to the Fedora 18 stable repository. If problems still persist, please make note of it in this bug report. |
Created attachment 606036 [details] Patch to add sphinx admonition labels instead of overriding visit_admonition() Description of problem: In the new docutils version (0.10 -- we're currently shipping a snapshot) there's a change to the manpage writer. Part of that change increments the indent level when visit_admonition() is called and decrements the indent level when depart_admonition() is called. Sphinx has its own manpage writer that customizes several aspects of the docutils manpage writer. One of those is to override visit_admonition() to add some new labels for admonitions. However, they do not also override depart_admonition(). This leads to a problem with the new version of docutils where the indent level is decremented past the top level leading to a traceback: File "/usr/lib/python2.7/site-packages/docutils/writers/manpage.py", line 877, in dedent self._indent.pop() IndexError: pop from empty list There's two ways that I see to rework this. * override depart_admonition() as well. * Instead of overriding visit_admonition(), add the additional labels to the data structure that docutils.writers.manpage will use. I'll attach a patch to do the latter that I am also sending upstream. We'll need to apply this in F18 and F19. Note: At this time python-docutils is not able to rebuild for python3-3.3 so we're not able to build anything that depends on it (including pyhton-sphinx). We have to wait on resoultion to that before we can push this fix out.