docutils 0.10 will break sphinx manpage writer

[shimizukawa]

In Fedora we've been working off of a docutils snapshot as we try to get our Linux distro prepared for Python-3.3. We noticed that there's a change to the docutils manpage writer that will break sphinx's manpage generation. Part of the docutils 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, it does 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 so that you can tell it not to decrement the indent level.
• 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.

---

• Bitbucket: https://bitbucket.org/birkenfeld/sphinx/issue/998
• Originally reported by: Toshio Kuratomi
• Originally created at: 2012-08-21T22:11:47.240

[shimizukawa]

From Georg Brandl on 2012-10-30 09:49:50+00:00

Closes #998: fix manpage writer in expectation of docutils 0.10 API change

→ <>