Add semantic markup support.

Author: felixfontein

changelogs/fragments/4-semantic-markup.yml

@@ -0,0 +1,2 @@
+major_changes:
+  - Support new semantic markup in documentation (https://github.com/ansible-community/antsibull-docs/pull/4).

pyproject.toml

@@ -38,7 +38,7 @@ ansible-pygments = "*"
 antsibull-core = ">= 1.0.0, < 2.0.0"
 asyncio-pool = "*"
 docutils = "*"
-jinja2 = "*"
+jinja2 = ">= 3.0"
 rstcheck = ">= 3.0.0, < 7.0.0"
 sphinx = "*"
 

src/antsibull_docs/jinja2/filters.py

@@ -8,15 +8,19 @@
 
 import json
 import re
+from functools import partial
 from html import escape as html_escape
 from urllib.parse import quote
 
 import typing as t
 
-from jinja2.runtime import Undefined
+from jinja2.runtime import Context, Undefined
+from jinja2.utils import pass_context
 
 from antsibull_core.logging import log
 
+from ..semantic_helper import parse_option, parse_return_value, augment_plugin_name_type
+
 
 mlog = log.fields(mod=__name__)
 
@@ -25,32 +29,152 @@
 _ITALIC = re.compile(r"\bI\(([^)]+)\)")
 _BOLD = re.compile(r"\bB\(([^)]+)\)")
 _MODULE = re.compile(r"\bM\(([^).]+)\.([^).]+)\.([^)]+)\)")
+_PLUGIN = re.compile(r"\bP\(([^).]+)\.([^).]+)\.([^)]+)#([a-z]+)\)")
 _URL = re.compile(r"\bU\(([^)]+)\)")
 _LINK = re.compile(r"\bL\(([^)]+), *([^)]+)\)")
 _REF = re.compile(r"\bR\(([^)]+), *([^)]+)\)")
 _CONST = re.compile(r"\bC\(([^)]+)\)")
+_SEM_PARAMETER_STRING = r"\(((?:[^\\)]+|\\.)+)\)"
+_SEM_OPTION_NAME = re.compile(r"\bO" + _SEM_PARAMETER_STRING)
+_SEM_OPTION_VALUE = re.compile(r"\bV" + _SEM_PARAMETER_STRING)
+_SEM_ENV_VARIABLE = re.compile(r"\bE" + _SEM_PARAMETER_STRING)
+_SEM_RET_VALUE = re.compile(r"\bRV" + _SEM_PARAMETER_STRING)
 _RULER = re.compile(r"\bHORIZONTALLINE\b")
+_UNESCAPE = re.compile(r"\\(.)")
 
 _EMAIL_ADDRESS = re.compile(r"(?:<{mail}>|\({mail}\)|{mail})".format(mail=r"[\w.+-]+@[\w.-]+\.\w+"))
 
 
-def html_ify(text):
+def extract_plugin_data(context: Context) -> t.Tuple[t.Optional[str], t.Optional[str]]:
+    plugin_fqcn = context.get('plugin_name')
+    plugin_type = context.get('plugin_type')
+    if plugin_fqcn is None or plugin_type is None:
+        return None, None
+    # if plugin_type == 'role':
+    #     entry_point = context.get('entry_point', 'main')
+    #     # FIXME: use entry_point
+    return plugin_fqcn, plugin_type
+
+
+def _unescape_sem_value(text: str) -> str:
+    return _UNESCAPE.sub(r'\1', text)
+
+
+def _check_plugin(plugin_fqcn: t.Optional[str], plugin_type: t.Optional[str],
+                  matcher: 're.Match') -> None:
+    if plugin_fqcn is None or plugin_type is None:
+        raise Exception(f'The markup {matcher.group(0)} cannot be used outside a plugin or role')
+
+
+def _create_error(text: str, error: str) -> str:  # pylint:disable=unused-argument
+    return '...'  # FIXME
+
+
+def _option_name_html(plugin_fqcn: t.Optional[str], plugin_type: t.Optional[str],
+                      matcher: 're.Match') -> str:
+    _check_plugin(plugin_fqcn, plugin_type, matcher)
+    text = _unescape_sem_value(matcher.group(1))
+    try:
+        plugin_fqcn, plugin_type, option_link, option, value = parse_option(
+            text, plugin_fqcn, plugin_type, require_plugin=False)
+    except ValueError as exc:
+        return _create_error(text, str(exc))
+    if value is None:
+        cls = 'ansible-option'
+        text = f'{option}'
+        strong_start = '<strong>'
+        strong_end = '</strong>'
+    else:
+        cls = 'ansible-option-value'
+        text = f'{option}={value}'
+        strong_start = ''
+        strong_end = ''
+    if plugin_fqcn and plugin_type and plugin_fqcn.count('.') >= 2:
+        # TODO: handle role arguments (entrypoint!)
+        namespace, name, plugin = plugin_fqcn.split('.', 2)
+        url = f'../../{namespace}/{name}/{plugin}_{plugin_type}.html'
+        fragment = f'parameter-{quote(option_link.replace(".", "/"))}'
+        link_start = (
+            f'<a class="reference internal" href="{url}#{fragment}">'
+            '<span class="std std-ref"><span class="pre">'
+        )
+        link_end = '</span></span></a>'
+    else:
+        link_start = ''
+        link_end = ''
+    return (
+        f'<code class="{cls} literal notranslate">'
+        f'{strong_start}{link_start}{text}{link_end}{strong_end}</code>'
+    )
+
+
+def _return_value_html(plugin_fqcn: t.Optional[str], plugin_type: t.Optional[str],
+                       matcher: 're.Match') -> str:
+    _check_plugin(plugin_fqcn, plugin_type, matcher)
+    text = _unescape_sem_value(matcher.group(1))
+    try:
+        plugin_fqcn, plugin_type, rv_link, rv, value = parse_return_value(
+            text, plugin_fqcn, plugin_type, require_plugin=False)
+    except ValueError as exc:
+        return _create_error(text, str(exc))
+    cls = 'ansible-return-value'
+    if value is None:
+        text = f'{rv}'
+    else:
+        text = f'{rv}={value}'
+    if plugin_fqcn and plugin_type and plugin_fqcn.count('.') >= 2:
+        namespace, name, plugin = plugin_fqcn.split('.', 2)
+        url = f'../../{namespace}/{name}/{plugin}_{plugin_type}.html'
+        fragment = f'return-{quote(rv_link.replace(".", "/"))}'
+        link_start = (
+            f'<a class="reference internal" href="{url}#{fragment}">'
+            '<span class="std std-ref"><span class="pre">'
+        )
+        link_end = '</span></span></a>'
+    else:
+        link_start = ''
+        link_end = ''
+    return f'<code class="{cls} literal notranslate">{link_start}{text}{link_end}</code>'
+
+
+def _value_html(matcher: 're.Match') -> str:
+    text = _unescape_sem_value(matcher.group(1))
+    return f'<code class="ansible-value literal notranslate">{text}</code>'
+
+
+def _env_var_html(matcher: 're.Match') -> str:
+    text = _unescape_sem_value(matcher.group(1))
+    return f'<code class="xref std std-envvar literal notranslate">{text}</code>'
+
+
+@pass_context
+def html_ify(context: Context, text: str) -> str:
     ''' convert symbols like I(this is in italics) to valid HTML '''
 
     flog = mlog.fields(func='html_ify')
     flog.fields(text=text).debug('Enter')
     _counts = {}
 
+    plugin_fqcn, plugin_type = extract_plugin_data(context)
+
     text = html_escape(text)
     text, _counts['italic'] = _ITALIC.subn(r"<em>\1</em>", text)
     text, _counts['bold'] = _BOLD.subn(r"<b>\1</b>", text)
     text, _counts['module'] = _MODULE.subn(
         r"<a href='../../\1/\2/\3_module.html' class='module'>\1.\2.\3</a>", text)
+    text, _counts['plugin'] = _PLUGIN.subn(
+        r"<a href='../../\1/\2/\3_\4.html' class='module plugin-\4'>\1.\2.\3</span>", text)
     text, _counts['url'] = _URL.subn(r"<a href='\1'>\1</a>", text)
     text, _counts['ref'] = _REF.subn(r"<span class='module'>\1</span>", text)
     text, _counts['link'] = _LINK.subn(r"<a href='\2'>\1</a>", text)
     text, _counts['const'] = _CONST.subn(
         r"<code class='docutils literal notranslate'>\1</code>", text)
+    text, _counts['option-name'] = _SEM_OPTION_NAME.subn(
+        partial(_option_name_html, plugin_fqcn, plugin_type), text)
+    text, _counts['option-value'] = _SEM_OPTION_VALUE.subn(_value_html, text)
+    text, _counts['environment-var'] = _SEM_ENV_VARIABLE.subn(_env_var_html, text)
+    text, _counts['return-value'] = _SEM_RET_VALUE.subn(
+        partial(_return_value_html, plugin_fqcn, plugin_type), text)
     text, _counts['ruler'] = _RULER.subn(r"<hr/>", text)
 
     text = text.strip()
@@ -98,6 +222,12 @@ def _rst_ify_module(m: 're.Match') -> str:
     return f"\\ :ref:`{rst_escape(fqcn)} <ansible_collections.{fqcn}_module>`\\ "
 
 
+def _rst_ify_plugin(m: 're.Match') -> str:
+    fqcn = f'{m.group(1)}.{m.group(2)}.{m.group(3)}'
+    plugin_type = m.group(4)
+    return f"\\ :ref:`{rst_escape(fqcn)} <ansible_collections.{fqcn}_{plugin_type}>`\\ "
+
+
 def _escape_url(url: str) -> str:
     # We include '<>[]{}' in safe to allow urls such as 'https://<HOST>:[PORT]/v{version}/' to
     # remain unmangled by percent encoding
@@ -121,20 +251,56 @@ def _rst_ify_const(m: 're.Match') -> str:
     return f"\\ :literal:`{rst_escape(m.group(1), escape_ending_whitespace=True)}`\\ "
 
 
-def rst_ify(text):
+def _rst_ify_option_name(plugin_fqcn: t.Optional[str], plugin_type: t.Optional[str],
+                         m: 're.Match') -> str:
+    _check_plugin(plugin_fqcn, plugin_type, m)
+    text = _unescape_sem_value(m.group(1))
+    text = augment_plugin_name_type(text, plugin_fqcn, plugin_type)
+    return f"\\ :ansopt:`{rst_escape(text, escape_ending_whitespace=True)}`\\ "
+
+
+def _rst_ify_value(m: 're.Match') -> str:
+    text = _unescape_sem_value(m.group(1))
+    return f"\\ :ansval:`{rst_escape(text, escape_ending_whitespace=True)}`\\ "
+
+
+def _rst_ify_return_value(plugin_fqcn: t.Optional[str], plugin_type: t.Optional[str],
+                          m: 're.Match') -> str:
+    _check_plugin(plugin_fqcn, plugin_type, m)
+    text = _unescape_sem_value(m.group(1))
+    text = augment_plugin_name_type(text, plugin_fqcn, plugin_type)
+    return f"\\ :ansretval:`{rst_escape(text, escape_ending_whitespace=True)}`\\ "
+
+
+def _rst_ify_envvar(m: 're.Match') -> str:
+    text = _unescape_sem_value(m.group(1))
+    return f"\\ :envvar:`{rst_escape(text, escape_ending_whitespace=True)}`\\ "
+
+
+@pass_context
+def rst_ify(context: Context, text: str) -> str:
     ''' convert symbols like I(this is in italics) to valid restructured text '''
 
     flog = mlog.fields(func='rst_ify')
     flog.fields(text=text).debug('Enter')
     _counts = {}
 
+    plugin_fqcn, plugin_type = extract_plugin_data(context)
+
     text, _counts['italic'] = _ITALIC.subn(_rst_ify_italic, text)
     text, _counts['bold'] = _BOLD.subn(_rst_ify_bold, text)
     text, _counts['module'] = _MODULE.subn(_rst_ify_module, text)
+    text, _counts['plugin'] = _PLUGIN.subn(_rst_ify_plugin, text)
     text, _counts['link'] = _LINK.subn(_rst_ify_link, text)
     text, _counts['url'] = _URL.subn(_rst_ify_url, text)
     text, _counts['ref'] = _REF.subn(_rst_ify_ref, text)
     text, _counts['const'] = _CONST.subn(_rst_ify_const, text)
+    text, _counts['option-name'] = _SEM_OPTION_NAME.subn(
+        partial(_rst_ify_option_name, plugin_fqcn, plugin_type), text)
+    text, _counts['option-value'] = _SEM_OPTION_VALUE.subn(_rst_ify_value, text)
+    text, _counts['environment-var'] = _SEM_ENV_VARIABLE.subn(_rst_ify_envvar, text)
+    text, _counts['return-value'] = _SEM_RET_VALUE.subn(
+        partial(_rst_ify_return_value, plugin_fqcn, plugin_type), text)
     text, _counts['ruler'] = _RULER.subn('\n\n.. raw:: html\n\n  <hr>\n\n', text)
 
     flog.fields(counts=_counts).info('Number of macros converted to rst equivalents')

src/antsibull_docs/lint_extra_docs.py

@@ -10,6 +10,10 @@
 import re
 import typing as t
 
+from docutils.parsers.rst import roles as docutils_roles
+
+from sphinx_antsibull_ext import roles as antsibull_roles
+
 from .extra_docs import (
     find_extra_docs,
     lint_required_conditions,
@@ -36,6 +40,12 @@ def lint_optional_conditions(content: str, path: str, collection_name: str
     return check_rst_content(content, filename=path)
 
 
+def _setup_antsibull_roles():
+    '''Make sure that rstcheck knows about our roles.'''
+    for name, role in antsibull_roles.ROLES.items():
+        docutils_roles.register_local_role(name, role)
+
+
 def lint_collection_extra_docs_files(path_to_collection: str
                                      ) -> t.List[t.Tuple[str, int, int, str]]:
     try:
@@ -47,6 +57,7 @@ def lint_collection_extra_docs_files(path_to_collection: str
     result = []
     all_labels = set()
     docs = find_extra_docs(path_to_collection)
+    _setup_antsibull_roles()
     for doc in docs:
         try:
             # Load content

src/antsibull_docs/semantic_helper.py

@@ -0,0 +1,85 @@
+# Author: Felix Fontein <[email protected]>
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
+# https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2021, Ansible Project
+"""
+Helpers for parsing semantic markup.
+"""
+
+import re
+
+import typing as t
+
+
+_ARRAY_STUB_RE = re.compile(r'\[([^\]]*)\]')
+_FQCN_TYPE_PREFIX_RE = re.compile(r'^([^.]+\.[^.]+\.[^#]+)#([a-z]+):(.*)$')
+_IGNORE_MARKER = 'ignore:'
+
+
+def _remove_array_stubs(text: str) -> str:
+    return _ARRAY_STUB_RE.sub('', text)
+
+
+def parse_option(text: str, plugin_fqcn: t.Optional[str], plugin_type: t.Optional[str],
+                 require_plugin=False) -> t.Tuple[str, str, str, str, t.Optional[str]]:
+    """
+    Given the contents of O(...) / :ansopt:`...` with potential escaping removed,
+    split it into plugin FQCN, plugin type, option link name, option name, and option value.
+    """
+    value = None
+    if '=' in text:
+        text, value = text.split('=', 1)
+    m = _FQCN_TYPE_PREFIX_RE.match(text)
+    if m:
+        plugin_fqcn = m.group(1)
+        plugin_type = m.group(2)
+        text = m.group(3)
+    elif require_plugin:
+        raise ValueError('Cannot extract plugin name and type')
+    elif text.startswith(_IGNORE_MARKER):
+        plugin_fqcn = ''
+        plugin_type = ''
+        text = text[len(_IGNORE_MARKER):]
+    if ':' in text or '#' in text:
+        raise ValueError(f'Invalid option name "{text}"')
+    return plugin_fqcn, plugin_type, _remove_array_stubs(text), text, value
+
+
+def parse_return_value(text: str, plugin_fqcn: t.Optional[str], plugin_type: t.Optional[str],
+                       require_plugin=False) -> t.Tuple[str, str, str, str, t.Optional[str]]:
+    """
+    Given the contents of RV(...) / :ansretval:`...` with potential escaping removed,
+    split it into plugin FQCN, plugin type, option link name, option name, and option value.
+    """
+    value = None
+    if '=' in text:
+        text, value = text.split('=', 1)
+    m = _FQCN_TYPE_PREFIX_RE.match(text)
+    if m:
+        plugin_fqcn = m.group(1)
+        plugin_type = m.group(2)
+        text = m.group(3)
+    elif require_plugin:
+        raise ValueError('Cannot extract plugin name and type')
+    elif text.startswith(_IGNORE_MARKER):
+        plugin_fqcn = ''
+        plugin_type = ''
+        text = text[len(_IGNORE_MARKER):]
+    if ':' in text or '#' in text:
+        raise ValueError(f'Invalid return value name "{text}"')
+    return plugin_fqcn, plugin_type, _remove_array_stubs(text), text, value
+
+
+def augment_plugin_name_type(text: str, plugin_fqcn: t.Optional[str], plugin_type: t.Optional[str]
+                             ) -> str:
+    """
+    Given the text contents of O(...) or RV(...) and a plugin's FQCN and type, insert
+    the FQCN and type if they are not already present.
+    """
+    value = None
+    if '=' in text:
+        text, value = text.split('=', 1)
+    if ':' not in text and plugin_fqcn and plugin_type:
+        text = f'{plugin_fqcn}#{plugin_type}:{text}'
+    return text if value is None else f'{text}={value}'

src/sphinx_antsibull_ext/__init__.py

@@ -14,6 +14,7 @@
 
 
 from .assets import setup_assets
+from .roles import setup_roles
 
 
 def setup(app):
@@ -25,6 +26,9 @@ def setup(app):
     # Add assets
     setup_assets(app)
 
+    # Add roles
+    setup_roles(app)
+
     return dict(
         parallel_read_safe=True,
         parallel_write_safe=True,