Welcome to sphinx-hwt documentation!

Readme File

Extension for Sphinx document generator. Add automatically generated schemes and other visual documentation of hardware. Currently mainly for `HWT library<https://github.com/Nic30/hwt.git>`_. (but VHDL,Verilog -> HWT is possible).

Contents:

• sphinx_hwt package
  • Submodules
  • sphinx_hwt.debugUtils module
    • hwt_HwModule_to_html()
  • sphinx_hwt.directive_autodoc module
    • HwtAutodocDirective
    • setup()
  • sphinx_hwt.directive_buildreport module
    • BuildreportPaths
    • HwtBuildReportTableDirective
    • HwtBuildreportDirective
    • get_config()
    • init_static_files_and_database()
    • setup()
  • sphinx_hwt.directive_components module
    • HwtComponentsDirective
    • hwt_components
    • merge_variable_lists_into_hwt_components()
    • setup()
  • sphinx_hwt.directive_io module
    • HwtIODirective
    • hwt_io
    • merge_variable_lists_into_hwt_io()
    • setup()
  • sphinx_hwt.directive_params module
    • HwtParamsDirective
    • hwt_params
    • merge_variable_lists_into_hwt_params()
    • setup()
  • sphinx_hwt.directive_schematic module
    • HwtSchematicDirective
    • SchematicLink
    • SchematicPaths
    • copy_scheme_viewer_static_files()
    • setup()
  • sphinx_hwt.sphinx_hwt module
    • setup()
  • sphinx_hwt.utils module
    • construct_hwt_obj()
    • construct_property_description_list()
    • generic_import()
    • get_absolute_name_of_class_of_node()
    • get_constructor_name()
    • get_instance_from_directive_node()
    • hwt_objs
    • merge_field_lists_to_hdl_objs()
    • merge_variable_lists_into_hwt_objs()
    • ref_to_class()

Indices and tables

• Index

• Module Index

• Search Page

Other sphinx plugins with similar code

• https://github.com/hasura/sphinx-graphiql/blob/master/sphinx_graphiql/sphinx_graphiql.py