diff options
| author | umarcor <unai.martinezcorral@ehu.eus> | 2021-02-01 09:08:00 +0100 |
|---|---|---|
| committer | umarcor <unai.martinezcorral@ehu.eus> | 2021-02-01 09:08:00 +0100 |
| commit | bcaadc4e36307110e203661b1300822be8e90373 (patch) | |
| tree | 26c4453cd408a43a36caa67be52f12761e8a3b55 /doc/pyGHDL/index.rst | |
| parent | 9c421e8524668f9ee06f5e9c2e3aa7c8e7dd7519 (diff) | |
| download | ghdl-bcaadc4e36307110e203661b1300822be8e90373.tar.gz ghdl-bcaadc4e36307110e203661b1300822be8e90373.tar.bz2 ghdl-bcaadc4e36307110e203661b1300822be8e90373.zip | |
doc: move pyGHDL intro to __init__.py
Diffstat (limited to 'doc/pyGHDL/index.rst')
| -rw-r--r-- | doc/pyGHDL/index.rst | 45 |
1 files changed, 2 insertions, 43 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. |