Improved docs

This commit is contained in:
2021-11-01 21:17:56 +01:00
parent 124b236182
commit 6eec92243e
65 changed files with 1886 additions and 25 deletions

View File

@@ -13,12 +13,9 @@ cpl **R** *<project>*
## Description
The command can be used to publish a project of type "console" or "library".
Removes a project reference and the files from workspace.
The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl_core.json```.
The command executes the ```setup.py``` and removes all source files with the ```setup.py``` from the 'publish/' directory.
Generated files of ```setup.py``` are in the 'publish/setup/' directory.
If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.
## Arguments

View File

@@ -0,0 +1,10 @@
cpl_query.exceptions
=================================
cpl_query.exceptions
----------------------------------------------------
.. automodule:: cpl_query.exceptions
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,26 @@
cpl_query.extension
=================================
cpl_query.extension.iterable_abc
----------------------------------------------------
.. automodule:: cpl_query.extension.iterable_abc
:members:
:undoc-members:
:show-inheritance:
cpl_query.extension.list
----------------------------------------------------
.. automodule:: cpl_query.extension.list
:members:
:undoc-members:
:show-inheritance:
cpl_query.extension.ordered_iterable_abc
----------------------------------------------------
.. automodule:: cpl_query.extension.ordered_iterable_abc
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,8 @@
Query Reference
===========
.. toctree::
:maxdepth: 4
cpl_query.extension
cpl_query.exceptions

View File

@@ -0,0 +1,45 @@
cpl\_query.tests package
========================
Submodules
----------
cpl\_query.tests.iterable\_test module
--------------------------------------
.. automodule:: cpl_query.tests.iterable_test
:members:
:undoc-members:
:show-inheritance:
cpl\_query.tests.models module
------------------------------
.. automodule:: cpl_query.tests.models
:members:
:undoc-members:
:show-inheritance:
cpl\_query.tests.query\_test module
-----------------------------------
.. automodule:: cpl_query.tests.query_test
:members:
:undoc-members:
:show-inheritance:
cpl\_query.tests.tester module
------------------------------
.. automodule:: cpl_query.tests.tester
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_query.tests
:members:
:undoc-members:
:show-inheritance:

View File

@@ -8,5 +8,6 @@ This CPL docs help you learn, understand and use the package. From your first ap
- [Getting started](quickstart)
- [Setup](setup)
- [API Reference](cpl)
- [API Reference](cpl_core)
- [CLI Reference](cli.overview)
- [Query Reference](cpl_query)