1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
# ==================================================================================================================== #
# _ _ _ #
# ___ _ __ | |__ (_)_ __ __ __ _ __ ___ _ __ ___ _ __| |_ ___ #
# / __| '_ \| '_ \| | '_ \\ \/ /____| '__/ _ \ '_ \ / _ \| '__| __/ __| #
# \__ \ |_) | | | | | | | |> <_____| | | __/ |_) | (_) | | | |_\__ \ #
# |___/ .__/|_| |_|_|_| |_/_/\_\ |_| \___| .__/ \___/|_| \__|___/ #
# |_| |_| #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2026-2026 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License 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. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
from typing import Tuple
from sphinx.writers.html5 import HTML5Translator
from pyTooling.Decorators import export
from sphinx_reports.Common import visitFunc, departFunc
from sphinx_reports.Node import Landscape
__all__ = ["translateLandscape"]
@export
def visit_Landscape(translator: HTML5Translator, node: Landscape) -> None:
"""
Call back function for visiting a :class:`Landscape`.
This function has no actions for HTML5.
:param translator: The HTML5 translator instance.
:param node: The current node being visited.
"""
@export
def depart_Landscape(translator: HTML5Translator, node: Landscape) -> None:
"""
Call back function for departing a :class:`Landscape`.
This function has no actions for HTML5.
:param translator: The HTML5 translator instance.
:param node: The current node being departed.
"""
translateLandscape: Tuple[visitFunc, departFunc] = (visit_Landscape, depart_Landscape)
"""A tuple combining both ``visit_*`` and ``depart_*`` call back functions for a :class:`Landscape` node."""
|