Coverage for hdl_registers/generator/html/html_translator.py: 100%
5 statements
« prev ^ index » next coverage.py v7.6.12, created at 2025-03-12 11:11 +0000
« prev ^ index » next coverage.py v7.6.12, created at 2025-03-12 11:11 +0000
1# --------------------------------------------------------------------------------------------------
2# Copyright (c) Lukas Vik. All rights reserved.
3#
4# This file is part of the hdl-registers project, an HDL register generator fast enough to run
5# in real time.
6# https://hdl-registers.com
7# https://github.com/hdl-registers/hdl-registers
8# --------------------------------------------------------------------------------------------------
10from docutils.core import publish_parts
11from docutils.writers.html5_polyglot import Writer
14class HtmlTranslator:
15 """
16 Translate a raw text with RST annotations into HTML code.
17 """
19 def translate(self, text: str) -> str:
20 """
21 Translate the text to have HTML tags where appropriate.
22 """
23 return publish_parts(source=text, writer=Writer())["fragment"].strip()