`vhdl_sphinx_domain` package

VHDL Domain for Sphinx

Package sub-modules

`ansi`	ANSI codes to print terminal text with colors or effects
`doc_utils`	Various Sphinx and docutils processing functions
`vhdl_domain`	Implements the Sphinx VHDL Domain and roles
`vhdl_parser`	Provides the `VHDLParser` class that is used to load and parse VHDL files and extract the key information (entities, ports etc.) in an easy to use structure.
`xelement`	Provides the XElement, which extends the ElementTree.Element functionalities

Module functions summary

`add_css_files`	Copy the assets from this package to the build folder.
`add_nojekyll`	Create a `.nojekyll` file in the html root folder to prevent github pages from using jekyll to process the pages
`autodoc_process_docstring`	Adds a horizontal line at the end of of each autodoc section to separate it from the members.
`builder_inited`
`doctree_resolved`	When the document, and all the links are fully resolved, we inject one raw html element for running the command for processing the wavedrom diagrams at the onload event.
`setup`	Initializes this Sphinx extension.

Module functions

add_css_files(app, exc)

Copy the assets from this package to the build folder.

This function is an event handler meant to be registered through app.connect().

Parameters:

Returns: result

add_nojekyll(app, exc)

Create a .nojekyll file in the html root folder to prevent github pages from using jekyll to process the pages

This function is an event handler meant to be registered through app.connect().

Parameters:

Returns: result

autodoc_process_docstring(app, what, name, obj, options, lines): Adds a horizontal line at the end of of each autodoc section to separate it from the members.

doctree_resolved(app, doctree, _fromdocname): When the document, and all the links are fully resolved, we inject one raw html element for running the command for processing the wavedrom diagrams at the onload event.

setup(app)

Initializes this Sphinx extension.

vhdl_sphinx_domain package