diff options
| -rw-r--r-- | doc/pyGHDL/index.rst | 45 | ||||
| -rw-r--r-- | pyGHDL/__init__.py | 17 |
2 files changed, 18 insertions, 44 deletions
diff --git a/doc/pyGHDL/index.rst b/doc/pyGHDL/index.rst index 549cc8c42..76462fd63 100644 --- a/doc/pyGHDL/index.rst +++ b/doc/pyGHDL/index.rst @@ -1,56 +1,15 @@ -.. _python_interface: - Python Interfaces ################# -.. # - we have 2 interfaces (libghdl, dom) and a service (LSP) as well as CLI entry points. - -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`` - High-level API as document object model (DOM). -* ``pyGHDL.libghdl`` - Low-level API to ``libghdl`` -* ``pyGHDL.lsp`` - Language server protocol (LSP) implementation and service - - -.. topic:: pyGHDL.libghdl - - *pyGHDL.libghdl* is 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. - - -.. topic:: pyGHDL.dom - - *pyGHDL.dom* is a high-level API offering a document object model (DOM). - The underlying abstract VHDL language model is provided by `pyVHDLModel <https://github.com/VHDL/pyVHDLModel>`__. - The DOM is using ``libghdl`` for file analysis and parsing. - - -.. topic:: pyGHDL.lsp - - *pyGHDL.lsp* is `language server protocol <https://en.wikipedia.org/wiki/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. - - .. toctree:: :hidden: - ../../pyGHDL/pyGHDL.cli - ../../pyGHDL/pyGHDL.dom - ../../pyGHDL/pyGHDL.libghdl - ../../pyGHDL/pyGHDL.lsp - + pyGHDL .. _CMDREF: Scripts and Applications -######################## +======================== The pyVHDLParser package comes with an executables registered by pip in the search path. diff --git a/pyGHDL/__init__.py b/pyGHDL/__init__.py index 90376f5f3..97ae27a03 100644 --- a/pyGHDL/__init__.py +++ b/pyGHDL/__init__.py @@ -31,4 +31,19 @@ # # SPDX-License-Identifier: GPL-2.0-or-later # ============================================================================ -# + +""" +.. _python_interface: + +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). The underlying abstract VHDL language model is + provided by `pyVHDLModel <https://github.com/VHDL/pyVHDLModel>`__. 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``. + This is a procedural and C-like interface. It comes with some Python generators for easier iterating linked lists. +* ``pyGHDL.lsp`` - A `language server protocol <https://en.wikipedia.org/wiki/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. +""" |