From 49bb019a9f57e52397c5f1b2bbfb20cd83645231 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Tue, 5 Jan 2021 00:07:53 +0100 Subject: Run AutoProgram to extract ghdl-ls CLI options. Add a link to gnatdoc. --- doc/AutoProgram.py | 39 +++++++++++++++++++++++++++++++++++++++ doc/LSP-AutoProgram.py | 35 ----------------------------------- doc/conf.py | 2 +- doc/gnatdoc/index.rst | 4 ++++ doc/index.rst | 1 + doc/using/pyGHDL/index.rst | 11 ++++++++++- 6 files changed, 55 insertions(+), 37 deletions(-) create mode 100644 doc/AutoProgram.py delete mode 100644 doc/LSP-AutoProgram.py create mode 100644 doc/gnatdoc/index.rst (limited to 'doc') diff --git a/doc/AutoProgram.py b/doc/AutoProgram.py new file mode 100644 index 000000000..4b13e60e6 --- /dev/null +++ b/doc/AutoProgram.py @@ -0,0 +1,39 @@ +# ============================================================================= +# 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 as lsp_parserGenerator +# from scripts.pnodes import _generateCLIParser as pnodes_parserGenerator +# from scripts.pnodespy import _generateCLIParser as pnodespy_parserGenerator + +# entry point +lsp_parser = lsp_parserGenerator() +# pnodes_parser = pnodes_parserGenerator() +# pnodespy_parser = pnodespy_parserGenerator() diff --git a/doc/LSP-AutoProgram.py b/doc/LSP-AutoProgram.py deleted file mode 100644 index 4acca7923..000000000 --- a/doc/LSP-AutoProgram.py +++ /dev/null @@ -1,35 +0,0 @@ -# ============================================================================= -# 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/conf.py b/doc/conf.py index ce6c134e7..baf7640f9 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -61,7 +61,7 @@ templates_path = ['_templates'] # This pattern also affects html_static_path and html_extra_path. exclude_patterns = [ "_build", - "_themes", + "_theme", "Thumbs.db", ".DS_Store" ] diff --git a/doc/gnatdoc/index.rst b/doc/gnatdoc/index.rst new file mode 100644 index 000000000..3bd4d51f1 --- /dev/null +++ b/doc/gnatdoc/index.rst @@ -0,0 +1,4 @@ +.. # This file is a placeholder and will be replaced + +gnatdoc +####### diff --git a/doc/index.rst b/doc/index.rst index 868cd9dec..cb36240f8 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -165,6 +165,7 @@ GHDL internals/Frontend internals/AST internals/RTI + gnatdoc/index .. raw:: latex diff --git a/doc/using/pyGHDL/index.rst b/doc/using/pyGHDL/index.rst index ed055957a..e22822ce6 100644 --- a/doc/using/pyGHDL/index.rst +++ b/doc/using/pyGHDL/index.rst @@ -39,6 +39,7 @@ this is provided from a ``pyGHDL`` packages with four sub-packages: .. toctree:: + :hidden: ../../pyGHDL/pyGHDL.cli ../../pyGHDL/pyGHDL.dom @@ -64,7 +65,15 @@ search path. .. _CMDREF-ghdlls: -.. autoprogram:: LSP-AutoProgram:parser +.. autoprogram:: AutoProgram:lsp_parser + :prog: ghdl-ls + :groups: + :label: CmdRef:ghdlls: + +.. _CMDREF-pnodes: + +.. # + autoprogram:: AutoProgram:pnodes_parser :prog: ghdl-ls :groups: :label: CmdRef:ghdlls: -- cgit v1.2.3