.. include:: ../../generated/sphinx_rst/index.rst

.. toctree::
    :caption: About
    :hidden:

    rst/about/about
    rst/about/release_notes
    rst/about/contributing
    rst/about/license_information

.. toctree::
    :caption: User guide
    :hidden:

    rst/user_guide/getting_started
    rst/user_guide/toml_format
    rst/user_guide/user_guide_python_api

.. toctree::
    :caption: Basic features
    :hidden:

    rst/basic_feature/basic_feature_register_modes
    rst/basic_feature/basic_feature_register_array
    rst/basic_feature/basic_feature_default_registers

.. toctree::
    :caption: Register fields
    :hidden:

    rst/field/field_overview
    rst/field/field_bit
    rst/field/field_bit_vector
    rst/field/field_enumeration
    rst/field/field_integer

.. toctree::
    :caption: Register constants
    :hidden:

    rst/constant/constant_overview
    rst/constant/constant_bit_vector
    rst/constant/constant_boolean
    rst/constant/constant_float
    rst/constant/constant_integer
    rst/constant/constant_string

.. toctree::
    :caption: Code generators
    :hidden:

    rst/generator/generator_c
    rst/generator/generator_cpp
    rst/generator/generator_html
    rst/generator/generator_python
    rst/generator/generator_vhdl

.. toctree::
    :caption: Extensions
    :hidden:

    rst/extensions/extensions_custom_generator

.. toctree::
    :caption: API reference
    :hidden:

    rst/api_reference/hdl_registers
    rst/api_reference/hdl_registers.field
    rst/api_reference/hdl_registers.constant
    rst/api_reference/hdl_registers.generator
    rst/api_reference/hdl_registers.generator.c
    rst/api_reference/hdl_registers.generator.cpp
    rst/api_reference/hdl_registers.generator.html
    rst/api_reference/hdl_registers.generator.python
    rst/api_reference/hdl_registers.generator.vhdl
    rst/api_reference/hdl_registers.generator.vhdl.axi_lite
    rst/api_reference/hdl_registers.generator.vhdl.simulation
    rst/api_reference/hdl_registers.parser