aboutsummaryrefslogtreecommitdiffstats
path: root/doc/using/pyGHDL/index.rst
diff options
context:
space:
mode:
authorPatrick Lehmann <Patrick.Lehmann@plc2.de>2021-01-04 23:06:29 +0100
committertgingold <tgingold@users.noreply.github.com>2021-01-05 18:50:44 +0100
commitf885f0794e77e0a6e8e0bd884dd4ec57890a5ddf (patch)
tree70e4430e3b7769b194992dd46bc90d275a8e5b4c /doc/using/pyGHDL/index.rst
parent22f1fbdd25b7927dc1aa235ee047cc698590f026 (diff)
downloadghdl-f885f0794e77e0a6e8e0bd884dd4ec57890a5ddf.tar.gz
ghdl-f885f0794e77e0a6e8e0bd884dd4ec57890a5ddf.tar.bz2
ghdl-f885f0794e77e0a6e8e0bd884dd4ec57890a5ddf.zip
Extract CLI parameters from ghdl-ls.
Diffstat (limited to 'doc/using/pyGHDL/index.rst')
-rw-r--r--doc/using/pyGHDL/index.rst25
1 files changed, 24 insertions, 1 deletions
diff --git a/doc/using/pyGHDL/index.rst b/doc/using/pyGHDL/index.rst
index fcedb20d2..ed055957a 100644
--- a/doc/using/pyGHDL/index.rst
+++ b/doc/using/pyGHDL/index.rst
@@ -39,9 +39,32 @@ this is provided from a ``pyGHDL`` packages with four sub-packages:
.. toctree::
- :hidden:
../../pyGHDL/pyGHDL.cli
../../pyGHDL/pyGHDL.dom
../../pyGHDL/pyGHDL.libghdl
../../pyGHDL/pyGHDL.lsp
+
+
+.. _CMDREF:
+
+Scripts and Applications
+########################
+
+The pyVHDLParser package comes with an executables registered by pip in the
+search path.
+
+* ``VHDLParser`` is a wrapper for ``pyVHDLParser.CLI.VHDLParser:main``.
+
+
+.. #
+ This files requires a Python module called 'Frontend-AutoProgram' to be
+ located in the 'doc' root folder. It expects a variable 'parser' of type
+ ArgumentParser.
+
+.. _CMDREF-ghdlls:
+
+.. autoprogram:: LSP-AutoProgram:parser
+ :prog: ghdl-ls
+ :groups:
+ :label: CmdRef:ghdlls: