HTML code generator

A complete HTML page can be generated, with register details as well as textual description of the different register modes. This is done by using the HtmlPageGenerator class e.g. like this:

Python code that parses the example TOML file and generates the HTML code we need.

# Standard libraries
import sys
from pathlib import Path

# First party libraries
from hdl_registers.generator.html.constant_table import HtmlConstantTableGenerator
from hdl_registers.generator.html.page import HtmlPageGenerator
from hdl_registers.generator.html.register_table import HtmlRegisterTableGenerator
from hdl_registers.parser.toml import from_toml

THIS_DIR = Path(__file__).parent


def main(output_folder: Path):
    """
    Create register HTML artifacts from the TOML example file.
    """
    register_list = from_toml(
        name="example",
        toml_file=THIS_DIR.parent.parent / "user_guide" / "toml" / "toml_format.toml",
    )

    HtmlPageGenerator(register_list=register_list, output_folder=output_folder).create()
    HtmlRegisterTableGenerator(register_list=register_list, output_folder=output_folder).create()
    HtmlConstantTableGenerator(register_list=register_list, output_folder=output_folder).create()


if __name__ == "__main__":
    main(output_folder=Path(sys.argv[1]))

A HTML page generated from the TOML format example can be viewed here: example_regs.html

Note

Markdown/reStructuredText syntax can be used in register and bit descriptions, which will be converted to appropriate HTML tags. Text can be set bold with double asterisks, and italicised with a single asterisk. A paragraph break can be inserted with consecutive newlines.

Tables only

Optionally, only the tables with register and constant descriptions can be generated to HTML, using the HtmlRegisterTableGenerator and HtmlConstantTableGenerator classes. These can be included in a separate documentation flow.

Generated HTML file here: example_register_table.html

Generated HTML file here: example_constant_table.html