Ignore :option: references in rst files to to simplify doc backports

Override Sphinx built-in :option: to act and render as `` literal.
This avoids problems with undefined :option:`target`s when merging
doc backports.

diff --git a/doc/arm/conf.py b/doc/arm/conf.py
index b147521a9e7d271ad7b88b99f371cb651cca694a..559e44958b76e470094cae7034b2c25ce1e3a261 100644 (file)
--- a/doc/arm/conf.py
+++ b/doc/arm/conf.py
@@ -82,6 +82,8 @@ class GitLabRefRole(ReferenceRole):
 def setup(app):
     roles.register_local_role('gl', GitLabRefRole(GITLAB_BASE_URL))
     app.add_crossref_type('iscman', 'iscman', 'pair: %s; manual page')
+    # ignore :option: references to simplify doc backports to v9_16 branch
+    app.add_role_to_domain('std', 'option', roles.code_role, override=True)
 
 #
 # Configuration file for the Sphinx documentation builder.

diff --git a/doc/man/conf.py b/doc/man/conf.py
index b3814848cc488e3b366bfd7bac01034b7499b92d..2c792377813af78063e895dd732c78ed3f8fc079 100644 (file)
--- a/doc/man/conf.py
+++ b/doc/man/conf.py
@@ -10,6 +10,8 @@
 # information regarding copyright ownership.
 
 # flake8: noqa: E501
+import datetime
+from docutils.parsers.rst import roles
 
 #
 # Configuration file for the Sphinx documentation builder.
@@ -32,7 +34,6 @@
 
 project = 'BIND 9'
 # pylint: disable=wrong-import-position
-import datetime
 year = datetime.datetime.now().year
 # pylint: disable=redefined-builtin
 copyright = "%d, Internet Systems Consortium" % year
@@ -109,3 +110,5 @@ man_pages = [
 
 def setup(app):
     app.add_crossref_type('iscman', 'iscman', 'pair: %s; manual page')
+    # ignore :option: references to simplify doc backports to v9_16 branch
+    app.add_role_to_domain('std', 'option', roles.code_role, override=True)