aboutsummaryrefslogtreecommitdiffstats
path: root/doc/using
diff options
context:
space:
mode:
authorumarcor <unai.martinezcorral@ehu.eus>2020-08-30 23:25:38 +0200
committertgingold <tgingold@users.noreply.github.com>2020-08-31 08:08:31 +0200
commite3672365cf95b98135c2b65446995dcd85b92d5e (patch)
tree56edf5320564be93fbc8550056e9606b49a8816c /doc/using
parent5b1f9ab31b9f46063f140afe6a4d5388d8e505bb (diff)
downloadghdl-e3672365cf95b98135c2b65446995dcd85b92d5e.tar.gz
ghdl-e3672365cf95b98135c2b65446995dcd85b92d5e.tar.bz2
ghdl-e3672365cf95b98135c2b65446995dcd85b92d5e.zip
doc: autodoc python modules (libghdl, thin, vhdl and pyutils)
Diffstat (limited to 'doc/using')
-rw-r--r--doc/using/py/libghdl.rst13
-rw-r--r--doc/using/py/pyutils.rst4
-rw-r--r--doc/using/py/thin.rst48
-rw-r--r--doc/using/py/vhdl.rst79
4 files changed, 144 insertions, 0 deletions
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