Skip to content

Commit

Permalink
Documentation is building again.
Browse files Browse the repository at this point in the history
  • Loading branch information
Paebbels committed Mar 8, 2023
1 parent feaea21 commit cf236aa
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 10 deletions.
14 changes: 14 additions & 0 deletions doc/_templates/autoapi/package.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. # Template created by Patrick Lehmann
Python Class Reference
######################

Reference of all packages and modules:

.. automodule:: {{ node.name }}

.. toctree::
:maxdepth: 1
{% for item in subnodes %}
{{ item.name }}
{%- endfor %}
10 changes: 9 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,16 @@
# ==============================================================================
autoapi_modules = {
"pyVHDLParser": {
# "template": "module",
"template": "package",
"output": "pyVHDLParser",
"override": True
}
}

for directory in [mod for mod in Path("../pyVHDLParser").iterdir() if mod.is_dir() and mod.name != "__pycache__"]:
print(f"Adding module rule for '{project}.{directory.name}'")
autoapi_modules[f"{project}.{directory.name}"] = {
"template": "module",
"output": "pyVHDLParser",
"override": True
}
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ This library is licensed under **Apache License 2.0**.
:caption: References
:hidden:

pyVHDLParser/index
pyVHDLParser/pyVHDLParser
References/index

.. raw:: latex
Expand Down
8 changes: 0 additions & 8 deletions doc/pyVHDLParser/index.rst

This file was deleted.

0 comments on commit cf236aa

Please sign in to comment.