Coverage for sphinx_reports / HTML.py: 100%

1# ==================================================================================================================== # 

2# _ _ _ # 

3# ___ _ __ | |__ (_)_ __ __ __ _ __ ___ _ __ ___ _ __| |_ ___ # 

4# / __| '_ \| '_ \| | '_ \\ \/ /____| '__/ _ \ '_ \ / _ \| '__| __/ __| # 

5# \__ \ |_) | | | | | | | |> <_____| | | __/ |_) | (_) | | | |_\__ \ # 

6# |___/ .__/|_| |_|_|_| |_/_/\_\ |_| \___| .__/ \___/|_| \__|___/ # 

7# |_| |_| # 

8# ==================================================================================================================== # 

9# Authors: # 

10# Patrick Lehmann # 

11# # 

12# License: # 

13# ==================================================================================================================== # 

14# Copyright 2026-2026 Patrick Lehmann - Bötzingen, Germany # 

15# # 

16# Licensed under the Apache License, Version 2.0 (the "License"); # 

17# you may not use this file except in compliance with the License. # 

18# You may obtain a copy of the License at # 

19# # 

20# http://www.apache.org/licenses/LICENSE-2.0 # 

21# # 

22# Unless required by applicable law or agreed to in writing, software # 

23# distributed under the License is distributed on an "AS IS" BASIS, # 

24# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # 

25# See the License for the specific language governing permissions and # 

26# limitations under the License. # 

27# # 

28# SPDX-License-Identifier: Apache-2.0 # 

29# ==================================================================================================================== # 

30# 

31from typing import Tuple 

32 

33from sphinx.writers.html5 import HTML5Translator 

34 

35from pyTooling.Decorators import export 

36from sphinx_reports.Common import visitFunc, departFunc 

37from sphinx_reports.Node import Landscape 

38 

39 

40__all__ = ["translateLandscape"] 

41 

42@export 

43def visit_Landscape(translator: HTML5Translator, node: Landscape) -> None: 

44 """ 

45 Call back function for visiting a :class:`Landscape`. 

46 

47 This function has no actions for HTML5. 

48 

49 :param translator: The HTML5 translator instance. 

50 :param node: The current node being visited. 

51 """ 

52 

53 

54@export 

55def depart_Landscape(translator: HTML5Translator, node: Landscape) -> None: 

56 """ 

57 Call back function for departing a :class:`Landscape`. 

58 

59 This function has no actions for HTML5. 

60 

61 :param translator: The HTML5 translator instance. 

62 :param node: The current node being departed. 

63 """ 

64 

65 

66translateLandscape: Tuple[visitFunc, departFunc] = (visit_Landscape, depart_Landscape) 

67"""A tuple combining both ``visit_*`` and ``depart_*`` call back functions for a :class:`Landscape` node."""