aboutsummaryrefslogtreecommitdiffstats
path: root/doc/using/pyGHDL
diff options
context:
space:
mode:
authorPatrick Lehmann <Patrick.Lehmann@plc2.de>2020-12-28 23:12:21 +0100
committerPatrick Lehmann <Patrick.Lehmann@plc2.de>2020-12-28 23:12:21 +0100
commit13fd5ccc6a8b9e59212b5493eb319c6f932eb906 (patch)
tree8ba15020049ae61917ca2c389a5b28feab6d6511 /doc/using/pyGHDL
parentbfd38acc0c6f3f82823fa1a496e90ef1e64da997 (diff)
parent8da838eff60114746a5d81e7d0c21bb5e777546e (diff)
downloadghdl-13fd5ccc6a8b9e59212b5493eb319c6f932eb906.tar.gz
ghdl-13fd5ccc6a8b9e59212b5493eb319c6f932eb906.tar.bz2
ghdl-13fd5ccc6a8b9e59212b5493eb319c6f932eb906.zip
Merge remote-tracking branch 'github-umarcor/py/GHDL' into paebbels/pyGHDL
Diffstat (limited to 'doc/using/pyGHDL')
-rw-r--r--doc/using/pyGHDL/index.rst11
-rw-r--r--doc/using/pyGHDL/libghdl.rst49
-rw-r--r--doc/using/pyGHDL/pyutils.rst4
-rw-r--r--doc/using/pyGHDL/vhdl.rst79
4 files changed, 143 insertions, 0 deletions
diff --git a/doc/using/pyGHDL/index.rst b/doc/using/pyGHDL/index.rst
new file mode 100644
index 000000000..ddbddec45
--- /dev/null
+++ b/doc/using/pyGHDL/index.rst
@@ -0,0 +1,11 @@
+.. _python_interface:
+
+Python Interface
+################
+
+.. toctree::
+ :hidden:
+
+ libghdl
+ vhdl
+ pyutils
diff --git a/doc/using/pyGHDL/libghdl.rst b/doc/using/pyGHDL/libghdl.rst
new file mode 100644
index 000000000..cc73b3a96
--- /dev/null
+++ b/doc/using/pyGHDL/libghdl.rst
@@ -0,0 +1,49 @@
+libghdl
+=======
+
+.. automodule:: libghdl
+
+libghdl.errorout
+----------------
+
+.. automodule:: libghdl.errorout
+
+libghdl.errorout_console
+------------------------
+
+.. automodule:: libghdl.errorout_console
+
+libghdl.errorout_memory
+-----------------------
+
+.. automodule:: libghdl.errorout_memory
+
+libghdl.files_map
+-----------------
+
+.. automodule:: libghdl.files_map
+
+libghdl.files_map_editor
+------------------------
+
+.. automodule:: libghdl.files_map_editor
+
+libghdl.flags
+-------------
+
+.. automodule:: libghdl.flags
+
+libghdl.libraries
+-----------------
+
+.. automodule:: libghdl.libraries
+
+libghdl.name_table
+------------------
+
+.. automodule:: libghdl.name_table
+
+libghdl.std_names
+-----------------
+
+.. automodule:: libghdl.std_names
diff --git a/doc/using/pyGHDL/pyutils.rst b/doc/using/pyGHDL/pyutils.rst
new file mode 100644
index 000000000..5efe078b8
--- /dev/null
+++ b/doc/using/pyGHDL/pyutils.rst
@@ -0,0 +1,4 @@
+libghdl.pyutils
+===============
+
+.. automodule:: libghdl.pyutils
diff --git a/doc/using/pyGHDL/vhdl.rst b/doc/using/pyGHDL/vhdl.rst
new file mode 100644
index 000000000..a18538011
--- /dev/null
+++ b/doc/using/pyGHDL/vhdl.rst
@@ -0,0 +1,79 @@
+libghdl.vhdl
+============
+
+.. automodule:: libghdl.vhdl
+
+libghdl.vhdl.canon
+------------------
+
+.. automodule:: libghdl.vhdl.canon
+
+libghdl.vhdl.elocations
+-----------------------
+
+.. automodule:: libghdl.vhdl.elocations
+
+libghdl.vhdl.flists
+-------------------
+
+.. automodule:: libghdl.vhdl.flists
+
+libghdl.vhdl.formatters
+-----------------------
+
+.. automodule:: libghdl.vhdl.formatters
+
+libghdl.vhdl.ieee
+-----------------
+
+.. automodule:: libghdl.vhdl.ieee
+
+libghdl.vhdl.lists
+------------------
+
+.. automodule:: libghdl.vhdl.lists
+
+libghdl.vhdl.nodes
+------------------
+
+.. automodule:: libghdl.vhdl.nodes
+
+libghdl.vhdl.nodes_meta
+-----------------------
+
+.. automodule:: libghdl.vhdl.nodes_meta
+
+libghdl.vhdl.nodes_utils
+------------------------
+
+.. automodule:: libghdl.vhdl.nodes_utils
+
+libghdl.vhdl.parse
+------------------
+
+.. automodule:: libghdl.vhdl.parse
+
+libghdl.vhdl.scanner
+--------------------
+
+.. automodule:: libghdl.vhdl.scanner
+
+libghdl.vhdl.sem
+----------------
+
+.. automodule:: libghdl.vhdl.sem
+
+libghdl.vhdl.sem_lib
+--------------------
+
+.. automodule:: libghdl.vhdl.sem_lib
+
+libghdl.vhdl.std_package
+------------------------
+
+.. automodule:: libghdl.vhdl.std_package
+
+libghdl.vhdl.tokens
+-------------------
+
+.. automodule:: libghdl.vhdl.tokens