From e3672365cf95b98135c2b65446995dcd85b92d5e Mon Sep 17 00:00:00 2001
From: umarcor <unai.martinezcorral@ehu.eus>
Date: Sun, 30 Aug 2020 23:25:38 +0200
Subject: doc: autodoc python modules (libghdl, thin, vhdl and pyutils)

---
 doc/conf.py              |  8 +++++
 doc/index.rst            |  1 +
 doc/make.sh              |  7 ++---
 doc/using/py/libghdl.rst | 13 ++++++++
 doc/using/py/pyutils.rst |  4 +++
 doc/using/py/thin.rst    | 48 +++++++++++++++++++++++++++++
 doc/using/py/vhdl.rst    | 79 ++++++++++++++++++++++++++++++++++++++++++++++++
 7 files changed, 156 insertions(+), 4 deletions(-)
 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')

diff --git a/doc/conf.py b/doc/conf.py
index 952d230c8..69ff6f139 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -16,6 +16,7 @@ needs_sphinx = '1.5'
 extensions = [
     # Standard Sphinx extensions
     'recommonmark',
+    'sphinx.ext.autodoc',
     'sphinx.ext.extlinks',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
@@ -27,6 +28,13 @@ extensions = [
     'exec',
 ]
 
+autodoc_default_options = {
+    "members": True,
+    'undoc-members': True,
+    #'private-members': True,
+    'inherited-members': True,
+}
+
 templates_path = ['_templates', '_themes']
 
 # The suffix(es) of source filenames.
diff --git a/doc/index.rst b/doc/index.rst
index 359c037f8..60efcd2a6 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -126,6 +126,7 @@
    using/Foreign
    using/ImplementationOfVHDL
    using/ImplementationOfVITAL
+   using/py/libghdl
 
 .. raw:: latex
 
diff --git a/doc/make.sh b/doc/make.sh
index faec1988e..b2852f777 100755
--- a/doc/make.sh
+++ b/doc/make.sh
@@ -5,13 +5,12 @@ set -e
 cd "$(dirname $0)"
 
 docker build -t ghdl/sphinx -f- . <<EOF
-FROM btdi/sphinx:featured
+FROM ghdl/vunit:llvm
 COPY requirements.txt /
-RUN apk add -U --no-cache make \
- && pip3 install -r /requirements.txt
+RUN pip3 install -r /requirements.txt
 EOF
 
-dcmd="docker run --rm -u $(id -u) -v /$(pwd)/..://tmp/src -w //tmp/src/doc"
+dcmd="docker run --rm -u $(id -u) -e PYTHONPATH=//tmp/src/python -v /$(pwd)/..://tmp/src -w //tmp/src/doc"
 
 $dcmd ghdl/sphinx sh -c "make html latex man"
 
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