diff options
Diffstat (limited to 'pyGHDL/__init__.py')
| -rw-r--r-- | pyGHDL/__init__.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/pyGHDL/__init__.py b/pyGHDL/__init__.py index 64a3c3d87..4e8bc2ca8 100644 --- a/pyGHDL/__init__.py +++ b/pyGHDL/__init__.py @@ -38,13 +38,13 @@ GHDL offers two Python interfaces and a language server protocol service. All this is provided from a ``pyGHDL`` packages with four sub-packages: -* ``pyGHDL.cli`` - Command line interface (CLI) applications. -* ``pyGHDL.dom`` - A high-level API offering a document object model (DOM). +* :mod:`pyGHDL.cli` - Command line interface (CLI) applications. +* :mod:`pyGHDL.dom` - A high-level API offering a document object model (DOM). The underlying abstract VHDL language model is provided by :doc:`pyVHDLModel <vhdlmodel:index>`. The DOM is using ``libghdl`` for file analysis and parsing. -* ``pyGHDL.libghdl`` - A low-level API directly interacting with the shared library ``libghdl....so``/``libghdl....dll``. +* :mod:`pyGHDL.libghdl` - A low-level API directly interacting with the shared library ``libghdl....so``/``libghdl....dll``. This is a procedural and C-like interface. It comes with some Python generators for easier iterating linked lists. -* ``pyGHDL.lsp`` - A :wikipedia:`language server protocol <Language_Server_Protocol>` (LSP) +* :mod:`pyGHDL.lsp` - A :wikipedia:`language server protocol <Language_Server_Protocol>` (LSP) written in Python. The implementation offers an HTTPS service that can be used e.g. by editors and IDEs supporting LSP. """ __author__ = "Tristan Gingold and contributors" |