1#@!#!123s

: / lib / python3 / dist-packages / botocore / docs /
Filename : translator.py
back
# Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
from docutils import nodes
from sphinx.locale import admonitionlabels
from sphinx.writers.html5 import HTML5Translator as SphinxHTML5Translator


class BotoHTML5Translator(SphinxHTML5Translator):
    """Extension of Sphinx's ``HTML5Translator`` for Botocore documentation."""

    IGNORE_IMPLICIT_HEADINGS = [
        '[REQUIRED]',
    ]

    def visit_admonition(self, node, name=""):
        """Uses the h3 tag for admonition titles instead of the p tag."""
        self.body.append(
            self.starttag(node, "div", CLASS=("admonition " + name))
        )
        if name:
            title = (
                f"<h3 class='admonition-title'> {admonitionlabels[name]}</h3>"
            )
            self.body.append(title)

    def is_implicit_heading(self, node):
        """Determines if a node is an implicit heading.

        An implicit heading is represented by a paragraph node whose only
        child is a strong node with text that isnt in `IGNORE_IMPLICIT_HEADINGS`.
        """
        return (
            len(node) == 1
            and isinstance(node[0], nodes.strong)
            and len(node[0]) == 1
            and isinstance(node[0][0], nodes.Text)
            and node[0][0].astext() not in self.IGNORE_IMPLICIT_HEADINGS
        )

    def visit_paragraph(self, node):
        """Visit a paragraph HTML element.

        Replaces implicit headings with an h3 tag and defers to default
        behavior for normal paragraph elements.
        """
        if self.is_implicit_heading(node):
            text = node[0][0]
            self.body.append(f'<h3>{text}</h3>\n')
            # Do not visit the current nodes children or call its depart method.
            raise nodes.SkipNode
        else:
            super().visit_paragraph(node)