]> git.ipfire.org Git - thirdparty/bind9.git/commit
Enable building documentation with Sphinx < 2.0.0
authorPetr Mensik <pemensik@redhat.com>
Fri, 15 Oct 2021 20:07:53 +0000 (22:07 +0200)
committerMichał Kępień <michal@isc.org>
Tue, 19 Oct 2021 11:41:57 +0000 (13:41 +0200)
commit8f8bbae3fc2fb82fc45d0a5e406182e8c28571e2
treeddf2deebe8864ee16c7ffab16b5b4df2d4a0b209
parent0c10fddedc23f20c1c6a94cfe892638e12a269dc
Enable building documentation with Sphinx < 2.0.0

The ReferenceRole class is only available in Sphinx >= 2.0.0, which
makes building BIND 9 documentation impossible with older Sphinx
versions:

    Running Sphinx v1.7.6

    Configuration error:
    There is a programable error in your configuration file:

    Traceback (most recent call last):
      File "/usr/lib/python3.6/site-packages/sphinx/config.py", line 161, in __init__
        execfile_(filename, config)
      File "/usr/lib/python3.6/site-packages/sphinx/util/pycompat.py", line 150, in execfile_
        exec_(code, _globals)
      File "conf.py", line 21, in <module>
        from sphinx.util.docutils import ReferenceRole
    ImportError: cannot import name 'ReferenceRole'

Work around the problem by defining a stub version of the ReferenceRole
class if the latter cannot be imported.  This allows documentation
(without GitLab hyperlinks in release notes) to be built with older
Sphinx versions.
doc/arm/conf.py