diff options
-rw-r--r-- | .github/workflows/doc.yml | 2 | ||||
-rw-r--r-- | doc/index.rst | 2 | ||||
-rw-r--r-- | doc/using/py/pyutils.rst | 4 | ||||
-rw-r--r-- | doc/using/py/thin.rst | 48 | ||||
-rw-r--r-- | doc/using/py/vhdl.rst | 79 | ||||
-rw-r--r-- | doc/using/pyGHDL/index.rst (renamed from doc/using/py/libghdl.rst) | 6 | ||||
-rw-r--r-- | doc/using/pyGHDL/libghdl.rst | 49 | ||||
-rw-r--r-- | doc/using/pyGHDL/utils.rst | 4 | ||||
-rw-r--r-- | doc/using/pyGHDL/vhdl.rst | 79 |
9 files changed, 136 insertions, 137 deletions
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 5cd33e03b..3ca172187 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -16,7 +16,7 @@ jobs: run: | docker build -t ghdl/doc - <<-EOF FROM ghdl/vunit:llvm - ENV PYTHONPATH=/src/python + ENV PYTHONPATH=/src/pyGHDL RUN apt update -qq && apt install -y gnat-gps \ && ln -s /usr/bin/pip3 /usr/bin/pip EOF diff --git a/doc/index.rst b/doc/index.rst index 8ea01b675..3fc554d56 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -145,7 +145,7 @@ GHDL using/Foreign using/ImplementationOfVHDL using/ImplementationOfVITAL - using/py/libghdl + using/pyGHDL/index .. raw:: latex diff --git a/doc/using/py/pyutils.rst b/doc/using/py/pyutils.rst deleted file mode 100644 index 58a84496a..000000000 --- a/doc/using/py/pyutils.rst +++ /dev/null @@ -1,4 +0,0 @@ -libghdl.thin.vhdl.pyutils -========================= - -.. automodule:: libghdl.thin.vhdl.pyutils diff --git a/doc/using/py/thin.rst b/doc/using/py/thin.rst deleted file mode 100644 index e02b48aec..000000000 --- a/doc/using/py/thin.rst +++ /dev/null @@ -1,48 +0,0 @@ -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 deleted file mode 100644 index e978cc6e8..000000000 --- a/doc/using/py/vhdl.rst +++ /dev/null @@ -1,79 +0,0 @@ -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 diff --git a/doc/using/py/libghdl.rst b/doc/using/pyGHDL/index.rst index 7c95ab8c1..2b2191798 100644 --- a/doc/using/py/libghdl.rst +++ b/doc/using/pyGHDL/index.rst @@ -3,11 +3,9 @@ Python Interface ################ -.. automodule:: libghdl - .. toctree:: :hidden: - thin + libghdl vhdl - pyutils + utils 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/utils.rst b/doc/using/pyGHDL/utils.rst new file mode 100644 index 000000000..682cb198b --- /dev/null +++ b/doc/using/pyGHDL/utils.rst @@ -0,0 +1,4 @@ +libghdl.utils +=============== + +.. automodule:: libghdl.utils 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 |