Skip to content
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

Allow cyrus to compile Sphinx documentation with Sphinx version 4..0 … #4542

Closed
wants to merge 1 commit into from
Closed

Allow cyrus to compile Sphinx documentation with Sphinx version 4..0 … #4542

wants to merge 1 commit into from

Commits on Jul 3, 2023

  1. Allow cyrus to compile Sphinx documentation with Sphinx version 4..0 … 

    …or greater

When compiling cyrus-imap 3.8.0 on debian 12 with Sphinx documentation  cyrus  fails to compile with the following  error:

Exception occurred:
|   File "/usr/lib/python3/dist-packages/docutils/writers/manpage.py", line 171, in __init__
|     self.settings = settings = document.settings
| AttributeError: 'CyrusManualPageBuilder' object has no attribute 'settings'

Cause: 

CyrusManualPageTranslator inherits from Sphinx' ManualPageTranslator and calls the super-class constructor as follows:

 BaseTranslator.__init__(self, builder, *args, **kwds)

However, starting with Sphinx 2.0 it should be called with document as the first argument and builder as the second one [1]. The old way of calling it
raised a warning for some time and was completely removed in Sphinx 4.0.
    @lol-catz
    lol-catz committed Jul 3, 2023
    Configuration menu
    Copy the full SHA
    61ed274 View commit details
    Browse the repository at this point in the history