From e3672365cf95b98135c2b65446995dcd85b92d5e Mon Sep 17 00:00:00 2001 From: umarcor Date: Sun, 30 Aug 2020 23:25:38 +0200 Subject: doc: autodoc python modules (libghdl, thin, vhdl and pyutils) --- doc/using/py/libghdl.rst | 13 ++++++++ doc/using/py/pyutils.rst | 4 +++ doc/using/py/thin.rst | 48 +++++++++++++++++++++++++++++ doc/using/py/vhdl.rst | 79 ++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 144 insertions(+) create mode 100644 doc/using/py/libghdl.rst create mode 100644 doc/using/py/pyutils.rst create mode 100644 doc/using/py/thin.rst create mode 100644 doc/using/py/vhdl.rst (limited to 'doc/using') diff --git a/doc/using/py/libghdl.rst b/doc/using/py/libghdl.rst new file mode 100644 index 000000000..7c95ab8c1 --- /dev/null +++ b/doc/using/py/libghdl.rst @@ -0,0 +1,13 @@ +.. _python_interface: + +Python Interface +################ + +.. automodule:: libghdl + +.. toctree:: + :hidden: + + thin + vhdl + pyutils diff --git a/doc/using/py/pyutils.rst b/doc/using/py/pyutils.rst new file mode 100644 index 000000000..58a84496a --- /dev/null +++ b/doc/using/py/pyutils.rst @@ -0,0 +1,4 @@ +libghdl.thin.vhdl.pyutils +========================= + +.. automodule:: libghdl.thin.vhdl.pyutils diff --git a/doc/using/py/thin.rst b/doc/using/py/thin.rst new file mode 100644 index 000000000..e02b48aec --- /dev/null +++ b/doc/using/py/thin.rst @@ -0,0 +1,48 @@ +libghdl.thin +============ + +libghdl.thin.errorout +--------------------- + +.. automodule:: libghdl.thin.errorout + +libghdl.thin.errorout_console +----------------------------- + +.. automodule:: libghdl.thin.errorout_console + +libghdl.thin.errorout_memory +----------------------------- + +.. automodule:: libghdl.thin.errorout_memory + +libghdl.thin.files_map +---------------------- + +.. automodule:: libghdl.thin.files_map + +libghdl.thin.files_map_editor +----------------------------- + +.. automodule:: libghdl.thin.files_map_editor + +libghdl.thin.flags +------------------ + +.. automodule:: libghdl.thin.flags + +libghdl.thin.libraries +---------------------- + +.. automodule:: libghdl.thin.libraries + +libghdl.thin.name_table +----------------------- + +.. automodule:: libghdl.thin.name_table + +libghdl.thin.std_names +---------------------- + +.. automodule:: libghdl.thin.std_names + diff --git a/doc/using/py/vhdl.rst b/doc/using/py/vhdl.rst new file mode 100644 index 000000000..e978cc6e8 --- /dev/null +++ b/doc/using/py/vhdl.rst @@ -0,0 +1,79 @@ +libghdl.thin.vhdl +================= + +.. automodule:: libghdl.thin.vhdl + +libghdl.thin.vhdl.canon +----------------------- + +.. automodule:: libghdl.thin.vhdl.canon + +libghdl.thin.vhdl.elocations +---------------------------- + +.. automodule:: libghdl.thin.vhdl.elocations + +libghdl.thin.vhdl.flists +------------------------ + +.. automodule:: libghdl.thin.vhdl.flists + +libghdl.thin.vhdl.formatters +---------------------------- + +.. automodule:: libghdl.thin.vhdl.formatters + +libghdl.thin.vhdl.ieee +---------------------- + +.. automodule:: libghdl.thin.vhdl.ieee + +libghdl.thin.vhdl.lists +----------------------- + +.. automodule:: libghdl.thin.vhdl.lists + +libghdl.thin.vhdl.nodes +----------------------- + +.. automodule:: libghdl.thin.vhdl.nodes + +libghdl.thin.vhdl.nodes_meta +---------------------------- + +.. automodule:: libghdl.thin.vhdl.nodes_meta + +libghdl.thin.vhdl.nodes_utils +----------------------------- + +.. automodule:: libghdl.thin.vhdl.nodes_utils + +libghdl.thin.vhdl.parse +----------------------- + +.. automodule:: libghdl.thin.vhdl.parse + +libghdl.thin.vhdl.scanner +------------------------- + +.. automodule:: libghdl.thin.vhdl.scanner + +libghdl.thin.vhdl.sem +--------------------- + +.. automodule:: libghdl.thin.vhdl.sem + +libghdl.thin.vhdl.sem_lib +------------------------- + +.. automodule:: libghdl.thin.vhdl.sem_lib + +libghdl.thin.vhdl.std_package +----------------------------- + +.. automodule:: libghdl.thin.vhdl.std_package + +libghdl.thin.vhdl.tokens +------------------------ + +.. automodule:: libghdl.thin.vhdl.tokens -- cgit v1.2.3