mirror of
https://gitlab.isc.org/isc-projects/bind9
synced 2025-09-05 09:05:40 +00:00
2fadf29e6b
Define a :gl: Sphinx role that takes a GitLab issue/MR number as an argument and creates a hyperlink to the relevant ISC GitLab URL. This makes it easy to reach ISC GitLab pages directly from the release notes. Make all GitLab references in the release notes use the new Sphinx role.
147 lines
4.7 KiB
Python
147 lines
4.7 KiB
Python
############################################################################
|
|
# Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
#
|
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
# file, you can obtain one at https://mozilla.org/MPL/2.0/.
|
|
#
|
|
# See the COPYRIGHT file distributed with this work for additional
|
|
# information regarding copyright ownership.
|
|
############################################################################
|
|
|
|
# flake8: noqa: E501
|
|
|
|
from typing import List, Tuple
|
|
|
|
from docutils import nodes
|
|
from docutils.nodes import Node, system_message
|
|
from docutils.parsers.rst import roles
|
|
|
|
from sphinx import addnodes
|
|
from sphinx.util.docutils import ReferenceRole
|
|
|
|
|
|
GITLAB_BASE_URL = 'https://gitlab.isc.org/isc-projects/bind9/-/'
|
|
|
|
|
|
# Custom Sphinx role enabling automatic hyperlinking to GitLab issues/MRs.
|
|
class GitLabRefRole(ReferenceRole):
|
|
def __init__(self, base_url: str) -> None:
|
|
self.base_url = base_url
|
|
super().__init__()
|
|
|
|
def run(self) -> Tuple[List[Node], List[system_message]]:
|
|
gl_identifier = '[GL %s]' % self.target
|
|
|
|
target_id = 'index-%s' % self.env.new_serialno('index')
|
|
entries = [('single', 'GitLab; ' + gl_identifier, target_id, '', None)]
|
|
|
|
index = addnodes.index(entries=entries)
|
|
target = nodes.target('', '', ids=[target_id])
|
|
self.inliner.document.note_explicit_target(target)
|
|
|
|
try:
|
|
refuri = self.build_uri()
|
|
reference = nodes.reference('', '', internal=False, refuri=refuri,
|
|
classes=['gl'])
|
|
if self.has_explicit_title:
|
|
reference += nodes.strong(self.title, self.title)
|
|
else:
|
|
reference += nodes.strong(gl_identifier, gl_identifier)
|
|
except ValueError:
|
|
error_text = 'invalid GitLab identifier %s' % self.target
|
|
msg = self.inliner.reporter.error(error_text, line=self.lineno)
|
|
prb = self.inliner.problematic(self.rawtext, self.rawtext, msg)
|
|
return [prb], [msg]
|
|
|
|
return [index, target, reference], []
|
|
|
|
def build_uri(self):
|
|
if self.target[0] == '#':
|
|
return self.base_url + 'issues/%d' % int(self.target[1:])
|
|
if self.target[0] == '!':
|
|
return self.base_url + 'merge_requests/%d' % int(self.target[1:])
|
|
raise ValueError
|
|
|
|
|
|
def setup(_):
|
|
roles.register_local_role('gl', GitLabRefRole(GITLAB_BASE_URL))
|
|
|
|
#
|
|
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# http://www.sphinx-doc.org/en/master/config
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
# import os
|
|
# import sys
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = u'BIND 9'
|
|
# pylint: disable=redefined-builtin
|
|
copyright = u'2021, Internet Systems Consortium'
|
|
author = u'Internet Systems Consortium'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = []
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = [
|
|
'_build',
|
|
'Thumbs.db',
|
|
'.DS_Store',
|
|
'*.grammar.rst',
|
|
'*.zoneopts.rst',
|
|
'catz.rst',
|
|
'dlz.rst',
|
|
'dnssec.rst',
|
|
'dyndb.rst',
|
|
'logging-cattegories.rst',
|
|
'managed-keys.rst',
|
|
'pkcs11.rst',
|
|
'plugins.rst'
|
|
]
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
# -- Options for EPUB output -------------------------------------------------
|
|
|
|
epub_basename = 'Bv9ARM'
|
|
|
|
# -- Options for LaTeX output ------------------------------------------------
|
|
latex_engine = 'xelatex'
|
|
|
|
# pylint disable=line-too-long
|
|
latex_documents = [
|
|
(master_doc, 'Bv9ARM.tex', u'BIND 9 Administrator Reference Manual', author, 'manual'),
|
|
]
|
|
|
|
latex_logo = "isc-logo.pdf"
|