diff options
| author | Patrick Lehmann <Patrick.Lehmann@plc2.de> | 2021-01-05 00:07:53 +0100 |
|---|---|---|
| committer | tgingold <tgingold@users.noreply.github.com> | 2021-01-05 18:50:44 +0100 |
| commit | 49bb019a9f57e52397c5f1b2bbfb20cd83645231 (patch) | |
| tree | 20145013e6586e67e7b738e6a440fb38244d62b4 /doc | |
| parent | f885f0794e77e0a6e8e0bd884dd4ec57890a5ddf (diff) | |
| download | ghdl-49bb019a9f57e52397c5f1b2bbfb20cd83645231.tar.gz ghdl-49bb019a9f57e52397c5f1b2bbfb20cd83645231.tar.bz2 ghdl-49bb019a9f57e52397c5f1b2bbfb20cd83645231.zip | |
Run AutoProgram to extract ghdl-ls CLI options. Add a link to gnatdoc.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/AutoProgram.py (renamed from doc/LSP-AutoProgram.py) | 8 | ||||
| -rw-r--r-- | doc/conf.py | 2 | ||||
| -rw-r--r-- | doc/gnatdoc/index.rst | 4 | ||||
| -rw-r--r-- | doc/index.rst | 1 | ||||
| -rw-r--r-- | doc/using/pyGHDL/index.rst | 11 |
5 files changed, 22 insertions, 4 deletions
diff --git a/doc/LSP-AutoProgram.py b/doc/AutoProgram.py index 4acca7923..4b13e60e6 100644 --- a/doc/LSP-AutoProgram.py +++ b/doc/AutoProgram.py @@ -29,7 +29,11 @@ from sys import path as sys_path sys_path.append("..") -from pyGHDL.cli.lsp import _generateCLIParser +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 -parser = _generateCLIParser() +lsp_parser = lsp_parserGenerator() +# pnodes_parser = pnodes_parserGenerator() +# pnodespy_parser = pnodespy_parserGenerator() 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: |