diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/LSP-AutoProgram.py | 35 | ||||
| -rw-r--r-- | doc/using/pyGHDL/index.rst | 25 |
2 files changed, 59 insertions, 1 deletions
diff --git a/doc/LSP-AutoProgram.py b/doc/LSP-AutoProgram.py new file mode 100644 index 000000000..4acca7923 --- /dev/null +++ b/doc/LSP-AutoProgram.py @@ -0,0 +1,35 @@ +# ============================================================================= +# Authors: Patrick Lehmann +# +# Package module: Stub module to extract argparse definitions. +# +# License: +# ============================================================================ +# Copyright (C) 2019-2021 Tristan Gingold +# +# GHDL is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation; either version 2, or (at your option) any later +# version. +# +# GHDL is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +# for more details. +# +# You should have received a copy of the GNU General Public License +# along with GHDL; see the file COPYING. If not, write to the Free +# Software Foundation, 59 Temple Place - Suite 330, Boston, MA +# 02111-1307, USA. +# +# SPDX-License-Identifier: GPL-2.0-or-later +# ============================================================================ +# +from sys import path as sys_path + +sys_path.append("..") + +from pyGHDL.cli.lsp import _generateCLIParser + +# entry point +parser = _generateCLIParser() 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: |