Updated docs #159

Merged
edraft merged 3 commits from #150 into 2023.4 2023-04-04 13:16:39 +02:00
632 changed files with 10917 additions and 6775 deletions
Showing only changes of commit 9e28dce5ce - Show all commits

View File

@ -1,6 +1,6 @@
{
"WorkspaceSettings": {
"DefaultProject": "cpl-cli",
"DefaultProject": "cpl-core",
"Projects": {
"cpl-cli": "src/cpl_cli/cpl-cli.json",
"cpl-core": "src/cpl_core/cpl-core.json",
@ -19,13 +19,15 @@
"Scripts": {
"hello-world": "echo 'Hello World'",
"format": "echo 'Formatting:'; black ./",
"sv": "cpl set-version",
"set-version": "cpl run set-version --dev $ARGS; echo '';",
"spu": "cpl set-pip-urls",
"set-pip-urls": "cpl run set-pip-urls --dev $ARGS; echo '';",
"docs-build": "echo 'Build Documentation'; cpl db-core; cpl db-discord; cpl db-query; cpl db-translation; cd docs/; make clean; make html; # rm source/cpl_query.tests.rst;",
"docs-build": "cpl format; echo 'Build Documentation'; cpl db-core; cpl db-discord; cpl db-query; cpl db-translation; cd docs/; make clean; make html;",
"db-core": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_core; cd ../",
"db-discord": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_discord; cd ../",
"db-query": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_query; cd ../",

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -29,4 +29,4 @@ If you call the command in a CPL workspace, you can use the project names. Other
| Argument | Description |
|------------------|:------------------------------------------:|
| ```--simulate``` | Specifies whether the command is simulated |
| ```--simulate``` | Specifies whether the command is simulated |

View File

@ -39,15 +39,15 @@ The cpl generate command takes as an argument the artifact to be generated. In
| Command | Alias | Description |
| ----------------------------- |:-------------:|:----------------:|
| [add](cli.add) | a or a | Adds a project reference to given project.
| [build](cli.build) | b or B | Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.
| [generate](cli.generate) | g or G | Generate a new file.
| [help](cli.help) | h or H | Lists available command and their short descriptions.
| [install](cli.install) | i or I | With argument installs packages to project, without argument installs project dependencies.
| [new](cli.new) | n or N | Creates new CPL project.
| [publish](cli.publish) | p or P | Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. Must be executed from within a library workspace directory.
| [remove](cli.remove) | r or R | Removes a project from workspace.
| [start](cli.start) | s or S | Starts CPL project, restarting on file changes.
| [uninstall](cli.uninstall) | ui or UI | Uninstalls packages from project.
| [update](cli.update) | u or U | Update CPL and project dependencies.
| [version](cli.version) | v or V | Outputs CPL CLI version.
| [add](cpl_cli.add) | a or a | Adds a project reference to given project.
| [build](cpl_cli.build) | b or B | Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.
| [generate](cpl_cli.generate) | g or G | Generate a new file.
| [help](cpl_cli.help) | h or H | Lists available command and their short descriptions.
| [install](cpl_cli.install) | i or I | With argument installs packages to project, without argument installs project dependencies.
| [new](cpl_cli.new) | n or N | Creates new CPL project.
| [publish](cpl_cli.publish) | p or P | Prepares files for publish into an output directory named dist/ at the given output path and executes ```setup.py```. Must be executed from within a library workspace directory.
| [remove](cpl_cli.remove) | r or R | Removes a project from workspace.
| [start](cpl_cli.start) | s or S | Starts CPL project, restarting on file changes.
| [uninstall](cpl_cli.uninstall) | ui or UI | Uninstalls packages from project.
| [update](cpl_cli.update) | u or U | Update CPL and project dependencies.
| [version](cpl_cli.version) | v or V | Outputs CPL CLI version.

View File

@ -4,16 +4,17 @@ CLI reference
.. toctree::
:maxdepth: 4
cli.overview
cli.add
cli.build
cli.generate
cli.help
cli.install
cli.new
cli.publish
cli.remove
cli.start
cli.uninstall
cli.update
cli.version
cpl_cli.overview
cpl_cli.add
cpl_cli.build
cpl_cli.generate
cpl_cli.help
cpl_cli.install
cpl_cli.new
cpl_cli.publish
cpl_cli.remove
cpl_cli.run
cpl_cli.start
cpl_cli.uninstall
cpl_cli.update
cpl_cli.version

View File

@ -1,34 +1,61 @@
cpl_core.application
=======================
cpl\_core.application package
=============================
cpl_core.application.application\_abc
---------------------------------------
Submodules
----------
cpl\_core.application.application\_abc module
---------------------------------------------
.. automodule:: cpl_core.application.application_abc
:members:
:undoc-members:
:show-inheritance:
cpl_core.application.application\_builder
-------------------------------------------
cpl\_core.application.application\_builder module
-------------------------------------------------
.. automodule:: cpl_core.application.application_builder
:members:
:undoc-members:
:show-inheritance:
cpl_core.application.application\_builder\_abc
------------------------------------------------
cpl\_core.application.application\_builder\_abc module
------------------------------------------------------
.. automodule:: cpl_core.application.application_builder_abc
:members:
:undoc-members:
:show-inheritance:
cpl_core.application.startup\_abc
-----------------------------------
cpl\_core.application.application\_extension\_abc module
--------------------------------------------------------
.. automodule:: cpl_core.application.application_extension_abc
:members:
:undoc-members:
:show-inheritance:
cpl\_core.application.startup\_abc module
-----------------------------------------
.. automodule:: cpl_core.application.startup_abc
:members:
:undoc-members:
:show-inheritance:
cpl\_core.application.startup\_extension\_abc module
----------------------------------------------------
.. automodule:: cpl_core.application.startup_extension_abc
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_core.application
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,42 +1,109 @@
cpl_core.configuration
=========================
cpl\_core.configuration package
===============================
cpl_core.configuration.configuration
--------------------------------------
Submodules
----------
cpl\_core.configuration.argument\_abc module
--------------------------------------------
.. automodule:: cpl_core.configuration.argument_abc
:members:
:undoc-members:
:show-inheritance:
cpl\_core.configuration.argument\_builder module
------------------------------------------------
.. automodule:: cpl_core.configuration.argument_builder
:members:
:undoc-members:
:show-inheritance:
cpl\_core.configuration.argument\_executable\_abc module
--------------------------------------------------------
.. automodule:: cpl_core.configuration.argument_executable_abc
:members:
:undoc-members:
:show-inheritance:
cpl\_core.configuration.argument\_type\_enum module
---------------------------------------------------
.. automodule:: cpl_core.configuration.argument_type_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_core.configuration.configuration module
--------------------------------------------
.. automodule:: cpl_core.configuration.configuration
:members:
:undoc-members:
:show-inheritance:
cpl_core.configuration.configuration\_abc
-------------------------------------------
cpl\_core.configuration.configuration\_abc module
-------------------------------------------------
.. automodule:: cpl_core.configuration.configuration_abc
:members:
:undoc-members:
:show-inheritance:
cpl_core.configuration.configuration\_model\_abc
--------------------------------------------------
cpl\_core.configuration.configuration\_model\_abc module
--------------------------------------------------------
.. automodule:: cpl_core.configuration.configuration_model_abc
:members:
:undoc-members:
:show-inheritance:
cpl_core.configuration.configuration\_variable\_name\_enum
------------------------------------------------------------
cpl\_core.configuration.configuration\_variable\_name\_enum module
------------------------------------------------------------------
.. automodule:: cpl_core.configuration.configuration_variable_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl_core.configuration.console\_argument
------------------------------------------
cpl\_core.configuration.executable\_argument module
---------------------------------------------------
.. automodule:: cpl_core.configuration.console_argument
.. automodule:: cpl_core.configuration.executable_argument
:members:
:undoc-members:
:show-inheritance:
cpl\_core.configuration.flag\_argument module
---------------------------------------------
.. automodule:: cpl_core.configuration.flag_argument
:members:
:undoc-members:
:show-inheritance:
cpl\_core.configuration.validator\_abc module
---------------------------------------------
.. automodule:: cpl_core.configuration.validator_abc
:members:
:undoc-members:
:show-inheritance:
cpl\_core.configuration.variable\_argument module
-------------------------------------------------
.. automodule:: cpl_core.configuration.variable_argument
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_core.configuration
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,42 +1,53 @@
cpl_core.console
===================
cpl\_core.console package
=========================
cpl_core.console.background\_color\_enum
------------------------------------------
Submodules
----------
cpl\_core.console.background\_color\_enum module
------------------------------------------------
.. automodule:: cpl_core.console.background_color_enum
:members:
:undoc-members:
:show-inheritance:
cpl_core.console.console
--------------------------
cpl\_core.console.console module
--------------------------------
.. automodule:: cpl_core.console.console
:members:
:undoc-members:
:show-inheritance:
cpl_core.console.console\_call
--------------------------------
cpl\_core.console.console\_call module
--------------------------------------
.. automodule:: cpl_core.console.console_call
:members:
:undoc-members:
:show-inheritance:
cpl_core.console.foreground\_color\_enum
------------------------------------------
cpl\_core.console.foreground\_color\_enum module
------------------------------------------------
.. automodule:: cpl_core.console.foreground_color_enum
:members:
:undoc-members:
:show-inheritance:
cpl_core.console.spinner\_thread
----------------------------------
cpl\_core.console.spinner\_thread module
----------------------------------------
.. automodule:: cpl_core.console.spinner_thread
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_core.console
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,18 +1,29 @@
cpl_core.database.connection
===============================
cpl\_core.database.connection package
=====================================
cpl_core.database.connection.database\_connection
---------------------------------------------------
Submodules
----------
cpl\_core.database.connection.database\_connection module
---------------------------------------------------------
.. automodule:: cpl_core.database.connection.database_connection
:members:
:undoc-members:
:show-inheritance:
cpl_core.database.connection.database\_connection\_abc
--------------------------------------------------------
cpl\_core.database.connection.database\_connection\_abc module
--------------------------------------------------------------
.. automodule:: cpl_core.database.connection.database_connection_abc
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_core.database.connection
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,18 +1,29 @@
cpl_core.database.context
============================
cpl\_core.database.context package
==================================
cpl_core.database.context.database\_context
---------------------------------------------
Submodules
----------
cpl\_core.database.context.database\_context module
---------------------------------------------------
.. automodule:: cpl_core.database.context.database_context
:members:
:undoc-members:
:show-inheritance:
cpl_core.database.context.database\_context\_abc
--------------------------------------------------
cpl\_core.database.context.database\_context\_abc module
--------------------------------------------------------
.. automodule:: cpl_core.database.context.database_context_abc
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_core.database.context
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,5 +1,8 @@
cpl_core.database
====================
cpl\_core.database package
==========================
Subpackages
-----------
.. toctree::
:maxdepth: 4
@ -7,28 +10,37 @@ cpl_core.database
cpl_core.database.connection
cpl_core.database.context
Submodules
----------
cpl_core.database.database\_model
-----------------------------------
.. automodule:: cpl_core.database.database_model
:members:
:undoc-members:
:show-inheritance:
cpl_core.database.database\_settings
--------------------------------------
cpl\_core.database.database\_settings module
--------------------------------------------
.. automodule:: cpl_core.database.database_settings
:members:
:undoc-members:
:show-inheritance:
cpl_core.database.database\_settings\_name\_enum
--------------------------------------------------
cpl\_core.database.database\_settings\_name\_enum module
--------------------------------------------------------
.. automodule:: cpl_core.database.database_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_core.database.table\_abc module
------------------------------------
.. automodule:: cpl_core.database.table_abc
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_core.database
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,50 +1,85 @@
cpl_core.dependency\_injection
=================================
cpl\_core.dependency\_injection package
=======================================
cpl_core.dependency\_injection.service\_collection
----------------------------------------------------
Submodules
----------
cpl\_core.dependency\_injection.scope module
--------------------------------------------
.. automodule:: cpl_core.dependency_injection.scope
:members:
:undoc-members:
:show-inheritance:
cpl\_core.dependency\_injection.scope\_abc module
-------------------------------------------------
.. automodule:: cpl_core.dependency_injection.scope_abc
:members:
:undoc-members:
:show-inheritance:
cpl\_core.dependency\_injection.scope\_builder module
-----------------------------------------------------
.. automodule:: cpl_core.dependency_injection.scope_builder
:members:
:undoc-members:
:show-inheritance:
cpl\_core.dependency\_injection.service\_collection module
----------------------------------------------------------
.. automodule:: cpl_core.dependency_injection.service_collection
:members:
:undoc-members:
:show-inheritance:
cpl_core.dependency\_injection.service\_collection\_abc
---------------------------------------------------------
cpl\_core.dependency\_injection.service\_collection\_abc module
---------------------------------------------------------------
.. automodule:: cpl_core.dependency_injection.service_collection_abc
:members:
:undoc-members:
:show-inheritance:
cpl_core.dependency\_injection.service\_descriptor
----------------------------------------------------
cpl\_core.dependency\_injection.service\_descriptor module
----------------------------------------------------------
.. automodule:: cpl_core.dependency_injection.service_descriptor
:members:
:undoc-members:
:show-inheritance:
cpl_core.dependency\_injection.service\_lifetime\_enum
--------------------------------------------------------
cpl\_core.dependency\_injection.service\_lifetime\_enum module
--------------------------------------------------------------
.. automodule:: cpl_core.dependency_injection.service_lifetime_enum
:members:
:undoc-members:
:show-inheritance:
cpl_core.dependency\_injection.service\_provider
--------------------------------------------------
cpl\_core.dependency\_injection.service\_provider module
--------------------------------------------------------
.. automodule:: cpl_core.dependency_injection.service_provider
:members:
:undoc-members:
:show-inheritance:
cpl_core.dependency\_injection.service\_provider\_abc
-------------------------------------------------------
cpl\_core.dependency\_injection.service\_provider\_abc module
-------------------------------------------------------------
.. automodule:: cpl_core.dependency_injection.service_provider_abc
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_core.dependency_injection
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,26 +1,37 @@
cpl_core.environment
=======================
cpl\_core.environment package
=============================
cpl_core.environment.application\_environment
-----------------------------------------------
Submodules
----------
cpl\_core.environment.application\_environment module
-----------------------------------------------------
.. automodule:: cpl_core.environment.application_environment
:members:
:undoc-members:
:show-inheritance:
cpl_core.environment.application\_environment\_abc
----------------------------------------------------
cpl\_core.environment.application\_environment\_abc module
----------------------------------------------------------
.. automodule:: cpl_core.environment.application_environment_abc
:members:
:undoc-members:
:show-inheritance:
cpl_core.environment.environment\_name\_enum
----------------------------------------------
cpl\_core.environment.environment\_name\_enum module
----------------------------------------------------
.. automodule:: cpl_core.environment.environment_name_enum
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_core.environment
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,42 +1,53 @@
cpl_core.logging
===================
cpl\_core.logging package
=========================
cpl_core.logging.logger\_abc
------------------------------
Submodules
----------
cpl\_core.logging.logger\_abc module
------------------------------------
.. automodule:: cpl_core.logging.logger_abc
:members:
:undoc-members:
:show-inheritance:
cpl_core.logging.logger\_service
----------------------------------
cpl\_core.logging.logger\_service module
----------------------------------------
.. automodule:: cpl_core.logging.logger_service
:members:
:undoc-members:
:show-inheritance:
cpl_core.logging.logging\_level\_enum
---------------------------------------
cpl\_core.logging.logging\_level\_enum module
---------------------------------------------
.. automodule:: cpl_core.logging.logging_level_enum
:members:
:undoc-members:
:show-inheritance:
cpl_core.logging.logging\_settings
------------------------------------
cpl\_core.logging.logging\_settings module
------------------------------------------
.. automodule:: cpl_core.logging.logging_settings
:members:
:undoc-members:
:show-inheritance:
cpl_core.logging.logging\_settings\_name\_enum
------------------------------------------------
cpl\_core.logging.logging\_settings\_name\_enum module
------------------------------------------------------
.. automodule:: cpl_core.logging.logging_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_core.logging
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,42 +1,53 @@
cpl_core.mailing
===================
cpl\_core.mailing package
=========================
cpl_core.mailing.email
------------------------
Submodules
----------
cpl\_core.mailing.email module
------------------------------
.. automodule:: cpl_core.mailing.email
:members:
:undoc-members:
:show-inheritance:
cpl_core.mailing.email\_client\_abc
-------------------------------------
cpl\_core.mailing.email\_client\_abc module
-------------------------------------------
.. automodule:: cpl_core.mailing.email_client_abc
:members:
:undoc-members:
:show-inheritance:
cpl_core.mailing.email\_client\_service
-----------------------------------------
cpl\_core.mailing.email\_client\_service module
-----------------------------------------------
.. automodule:: cpl_core.mailing.email_client_service
:members:
:undoc-members:
:show-inheritance:
cpl_core.mailing.email\_client\_settings
------------------------------------------
cpl\_core.mailing.email\_client\_settings module
------------------------------------------------
.. automodule:: cpl_core.mailing.email_client_settings
:members:
:undoc-members:
:show-inheritance:
cpl_core.mailing.email\_client\_settings\_name\_enum
------------------------------------------------------
cpl\_core.mailing.email\_client\_settings\_name\_enum module
------------------------------------------------------------
.. automodule:: cpl_core.mailing.email_client_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_core.mailing
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,9 +1,10 @@
cpl\_core.pipes
cpl\_core.pipes package
=======================
Submodules
----------
cpl\_core.pipes.bool\_pipe
cpl\_core.pipes.bool\_pipe module
---------------------------------
.. automodule:: cpl_core.pipes.bool_pipe
@ -11,7 +12,7 @@ cpl\_core.pipes.bool\_pipe
:undoc-members:
:show-inheritance:
cpl\_core.pipes.first\_char\_to\_lower\_pipe
cpl\_core.pipes.first\_char\_to\_lower\_pipe module
---------------------------------------------------
.. automodule:: cpl_core.pipes.first_char_to_lower_pipe
@ -19,7 +20,7 @@ cpl\_core.pipes.first\_char\_to\_lower\_pipe
:undoc-members:
:show-inheritance:
cpl\_core.pipes.first\_to\_upper\_pipe
cpl\_core.pipes.first\_to\_upper\_pipe module
---------------------------------------------
.. automodule:: cpl_core.pipes.first_to_upper_pipe
@ -27,7 +28,7 @@ cpl\_core.pipes.first\_to\_upper\_pipe
:undoc-members:
:show-inheritance:
cpl\_core.pipes.ip\_address\_pipe
cpl\_core.pipes.ip\_address\_pipe module
----------------------------------------
.. automodule:: cpl_core.pipes.ip_address_pipe
@ -35,7 +36,7 @@ cpl\_core.pipes.ip\_address\_pipe
:undoc-members:
:show-inheritance:
cpl\_core.pipes.pipe\_abc
cpl\_core.pipes.pipe\_abc module
--------------------------------
.. automodule:: cpl_core.pipes.pipe_abc
@ -43,7 +44,7 @@ cpl\_core.pipes.pipe\_abc
:undoc-members:
:show-inheritance:
cpl\_core.pipes.to\_camel\_case\_pipe
cpl\_core.pipes.to\_camel\_case\_pipe module
--------------------------------------------
.. automodule:: cpl_core.pipes.to_camel_case_pipe
@ -51,7 +52,7 @@ cpl\_core.pipes.to\_camel\_case\_pipe
:undoc-members:
:show-inheritance:
cpl\_core.pipes.to\_snake\_case\_pipe
cpl\_core.pipes.to\_snake\_case\_pipe module
--------------------------------------------
.. automodule:: cpl_core.pipes.to_snake_case_pipe
@ -59,10 +60,18 @@ cpl\_core.pipes.to\_snake\_case\_pipe
:undoc-members:
:show-inheritance:
cpl\_core.pipes.version\_pipe
cpl\_core.pipes.version\_pipe module
------------------------------------
.. automodule:: cpl_core.pipes.version_pipe
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_core.pipes
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,5 +1,5 @@
API reference
===========
=============
.. toctree::
:maxdepth: 4
@ -15,3 +15,4 @@ API reference
cpl_core.pipes
cpl_core.time
cpl_core.utils

View File

@ -1,18 +1,29 @@
cpl_core.time
================
cpl\_core.time package
======================
cpl_core.time.time\_format\_settings
--------------------------------------
Submodules
----------
cpl\_core.time.time\_format\_settings module
--------------------------------------------
.. automodule:: cpl_core.time.time_format_settings
:members:
:undoc-members:
:show-inheritance:
cpl_core.time.time\_format\_settings\_names\_enum
---------------------------------------------------
cpl\_core.time.time\_format\_settings\_names\_enum module
---------------------------------------------------------
.. automodule:: cpl_core.time.time_format_settings_names_enum
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_core.time
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,26 +1,37 @@
cpl_core.utils
=================
cpl\_core.utils package
=======================
cpl_core.utils.credential\_manager
------------------------------------
Submodules
----------
cpl\_core.utils.credential\_manager module
------------------------------------------
.. automodule:: cpl_core.utils.credential_manager
:members:
:undoc-members:
:show-inheritance:
cpl_core.utils.pip
--------------------
cpl\_core.utils.pip module
--------------------------
.. automodule:: cpl_core.utils.pip
:members:
:undoc-members:
:show-inheritance:
cpl_core.utils.string
-----------------------
cpl\_core.utils.string module
-----------------------------
.. automodule:: cpl_core.utils.string
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_core.utils
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,12 +1,21 @@
cpl\_discord.application
cpl\_discord.application package
================================
Submodules
----------
cpl\_discord.application.discord\_bot\_application\_abc
cpl\_discord.application.discord\_bot\_application\_abc module
--------------------------------------------------------------
.. automodule:: cpl_discord.application.discord_bot_application_abc
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_discord.application
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,9 +1,10 @@
cpl\_discord.command
cpl\_discord.command package
============================
Submodules
----------
cpl\_discord.command.discord\_command\_abc
cpl\_discord.command.discord\_command\_abc module
-------------------------------------------------
.. automodule:: cpl_discord.command.discord_command_abc
@ -11,10 +12,18 @@ cpl\_discord.command.discord\_command\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.command.discord\_commands\_meta
cpl\_discord.command.discord\_commands\_meta module
---------------------------------------------------
.. automodule:: cpl_discord.command.discord_commands_meta
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_discord.command
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,12 +1,21 @@
cpl\_discord.configuration
cpl\_discord.configuration package
==================================
Submodules
----------
cpl\_discord.configuration.discord\_bot\_settings
cpl\_discord.configuration.discord\_bot\_settings module
--------------------------------------------------------
.. automodule:: cpl_discord.configuration.discord_bot_settings
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_discord.configuration
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,9 +1,10 @@
cpl\_discord.container
cpl\_discord.container package
==============================
Submodules
----------
cpl\_discord.container.category\_channel
cpl\_discord.container.category\_channel module
-----------------------------------------------
.. automodule:: cpl_discord.container.category_channel
@ -11,7 +12,7 @@ cpl\_discord.container.category\_channel
:undoc-members:
:show-inheritance:
cpl\_discord.container.container
cpl\_discord.container.container module
---------------------------------------
.. automodule:: cpl_discord.container.container
@ -19,7 +20,7 @@ cpl\_discord.container.container
:undoc-members:
:show-inheritance:
cpl\_discord.container.guild
cpl\_discord.container.guild module
-----------------------------------
.. automodule:: cpl_discord.container.guild
@ -27,7 +28,7 @@ cpl\_discord.container.guild
:undoc-members:
:show-inheritance:
cpl\_discord.container.member
cpl\_discord.container.member module
------------------------------------
.. automodule:: cpl_discord.container.member
@ -35,7 +36,7 @@ cpl\_discord.container.member
:undoc-members:
:show-inheritance:
cpl\_discord.container.role
cpl\_discord.container.role module
----------------------------------
.. automodule:: cpl_discord.container.role
@ -43,7 +44,7 @@ cpl\_discord.container.role
:undoc-members:
:show-inheritance:
cpl\_discord.container.text\_channel
cpl\_discord.container.text\_channel module
-------------------------------------------
.. automodule:: cpl_discord.container.text_channel
@ -51,7 +52,7 @@ cpl\_discord.container.text\_channel
:undoc-members:
:show-inheritance:
cpl\_discord.container.thread
cpl\_discord.container.thread module
------------------------------------
.. automodule:: cpl_discord.container.thread
@ -59,10 +60,18 @@ cpl\_discord.container.thread
:undoc-members:
:show-inheritance:
cpl\_discord.container.voice\_channel
cpl\_discord.container.voice\_channel module
--------------------------------------------
.. automodule:: cpl_discord.container.voice_channel
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_discord.container
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,9 +1,10 @@
cpl\_discord.events
cpl\_discord.events package
===========================
Submodules
----------
cpl\_discord.events.on\_bulk\_message\_delete\_abc
cpl\_discord.events.on\_bulk\_message\_delete\_abc module
---------------------------------------------------------
.. automodule:: cpl_discord.events.on_bulk_message_delete_abc
@ -11,7 +12,7 @@ cpl\_discord.events.on\_bulk\_message\_delete\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_command\_abc
cpl\_discord.events.on\_command\_abc module
-------------------------------------------
.. automodule:: cpl_discord.events.on_command_abc
@ -19,7 +20,7 @@ cpl\_discord.events.on\_command\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_command\_completion\_abc
cpl\_discord.events.on\_command\_completion\_abc module
-------------------------------------------------------
.. automodule:: cpl_discord.events.on_command_completion_abc
@ -27,7 +28,7 @@ cpl\_discord.events.on\_command\_completion\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_command\_error\_abc
cpl\_discord.events.on\_command\_error\_abc module
--------------------------------------------------
.. automodule:: cpl_discord.events.on_command_error_abc
@ -35,7 +36,7 @@ cpl\_discord.events.on\_command\_error\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_connect\_abc
cpl\_discord.events.on\_connect\_abc module
-------------------------------------------
.. automodule:: cpl_discord.events.on_connect_abc
@ -43,7 +44,7 @@ cpl\_discord.events.on\_connect\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_disconnect\_abc
cpl\_discord.events.on\_disconnect\_abc module
----------------------------------------------
.. automodule:: cpl_discord.events.on_disconnect_abc
@ -51,7 +52,7 @@ cpl\_discord.events.on\_disconnect\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_error\_abc
cpl\_discord.events.on\_error\_abc module
-----------------------------------------
.. automodule:: cpl_discord.events.on_error_abc
@ -59,7 +60,7 @@ cpl\_discord.events.on\_error\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_group\_join\_abc
cpl\_discord.events.on\_group\_join\_abc module
-----------------------------------------------
.. automodule:: cpl_discord.events.on_group_join_abc
@ -67,7 +68,7 @@ cpl\_discord.events.on\_group\_join\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_group\_remove\_abc
cpl\_discord.events.on\_group\_remove\_abc module
-------------------------------------------------
.. automodule:: cpl_discord.events.on_group_remove_abc
@ -75,7 +76,7 @@ cpl\_discord.events.on\_group\_remove\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_available\_abc
cpl\_discord.events.on\_guild\_available\_abc module
----------------------------------------------------
.. automodule:: cpl_discord.events.on_guild_available_abc
@ -83,7 +84,7 @@ cpl\_discord.events.on\_guild\_available\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_channel\_create\_abc
cpl\_discord.events.on\_guild\_channel\_create\_abc module
----------------------------------------------------------
.. automodule:: cpl_discord.events.on_guild_channel_create_abc
@ -91,7 +92,7 @@ cpl\_discord.events.on\_guild\_channel\_create\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_channel\_delete\_abc
cpl\_discord.events.on\_guild\_channel\_delete\_abc module
----------------------------------------------------------
.. automodule:: cpl_discord.events.on_guild_channel_delete_abc
@ -99,7 +100,7 @@ cpl\_discord.events.on\_guild\_channel\_delete\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_channel\_pins\_update\_abc
cpl\_discord.events.on\_guild\_channel\_pins\_update\_abc module
----------------------------------------------------------------
.. automodule:: cpl_discord.events.on_guild_channel_pins_update_abc
@ -107,7 +108,7 @@ cpl\_discord.events.on\_guild\_channel\_pins\_update\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_channel\_update\_abc
cpl\_discord.events.on\_guild\_channel\_update\_abc module
----------------------------------------------------------
.. automodule:: cpl_discord.events.on_guild_channel_update_abc
@ -115,7 +116,7 @@ cpl\_discord.events.on\_guild\_channel\_update\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_emojis\_update\_abc
cpl\_discord.events.on\_guild\_emojis\_update\_abc module
---------------------------------------------------------
.. automodule:: cpl_discord.events.on_guild_emojis_update_abc
@ -123,7 +124,7 @@ cpl\_discord.events.on\_guild\_emojis\_update\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_integrations\_update\_abc
cpl\_discord.events.on\_guild\_integrations\_update\_abc module
---------------------------------------------------------------
.. automodule:: cpl_discord.events.on_guild_integrations_update_abc
@ -131,7 +132,7 @@ cpl\_discord.events.on\_guild\_integrations\_update\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_join\_abc
cpl\_discord.events.on\_guild\_join\_abc module
-----------------------------------------------
.. automodule:: cpl_discord.events.on_guild_join_abc
@ -139,7 +140,7 @@ cpl\_discord.events.on\_guild\_join\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_remove\_abc
cpl\_discord.events.on\_guild\_remove\_abc module
-------------------------------------------------
.. automodule:: cpl_discord.events.on_guild_remove_abc
@ -147,7 +148,7 @@ cpl\_discord.events.on\_guild\_remove\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_role\_create\_abc
cpl\_discord.events.on\_guild\_role\_create\_abc module
-------------------------------------------------------
.. automodule:: cpl_discord.events.on_guild_role_create_abc
@ -155,7 +156,7 @@ cpl\_discord.events.on\_guild\_role\_create\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_role\_delete\_abc
cpl\_discord.events.on\_guild\_role\_delete\_abc module
-------------------------------------------------------
.. automodule:: cpl_discord.events.on_guild_role_delete_abc
@ -163,7 +164,7 @@ cpl\_discord.events.on\_guild\_role\_delete\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_role\_update\_abc
cpl\_discord.events.on\_guild\_role\_update\_abc module
-------------------------------------------------------
.. automodule:: cpl_discord.events.on_guild_role_update_abc
@ -171,7 +172,7 @@ cpl\_discord.events.on\_guild\_role\_update\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_unavailable\_abc
cpl\_discord.events.on\_guild\_unavailable\_abc module
------------------------------------------------------
.. automodule:: cpl_discord.events.on_guild_unavailable_abc
@ -179,7 +180,7 @@ cpl\_discord.events.on\_guild\_unavailable\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_guild\_update\_abc
cpl\_discord.events.on\_guild\_update\_abc module
-------------------------------------------------
.. automodule:: cpl_discord.events.on_guild_update_abc
@ -187,7 +188,7 @@ cpl\_discord.events.on\_guild\_update\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_invite\_create\_abc
cpl\_discord.events.on\_invite\_create\_abc module
--------------------------------------------------
.. automodule:: cpl_discord.events.on_invite_create_abc
@ -195,7 +196,7 @@ cpl\_discord.events.on\_invite\_create\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_invite\_delete\_abc
cpl\_discord.events.on\_invite\_delete\_abc module
--------------------------------------------------
.. automodule:: cpl_discord.events.on_invite_delete_abc
@ -203,7 +204,7 @@ cpl\_discord.events.on\_invite\_delete\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_member\_ban\_abc
cpl\_discord.events.on\_member\_ban\_abc module
-----------------------------------------------
.. automodule:: cpl_discord.events.on_member_ban_abc
@ -211,7 +212,7 @@ cpl\_discord.events.on\_member\_ban\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_member\_join\_abc
cpl\_discord.events.on\_member\_join\_abc module
------------------------------------------------
.. automodule:: cpl_discord.events.on_member_join_abc
@ -219,7 +220,7 @@ cpl\_discord.events.on\_member\_join\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_member\_remove\_abc
cpl\_discord.events.on\_member\_remove\_abc module
--------------------------------------------------
.. automodule:: cpl_discord.events.on_member_remove_abc
@ -227,7 +228,7 @@ cpl\_discord.events.on\_member\_remove\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_member\_unban\_abc
cpl\_discord.events.on\_member\_unban\_abc module
-------------------------------------------------
.. automodule:: cpl_discord.events.on_member_unban_abc
@ -235,7 +236,7 @@ cpl\_discord.events.on\_member\_unban\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_member\_update\_abc
cpl\_discord.events.on\_member\_update\_abc module
--------------------------------------------------
.. automodule:: cpl_discord.events.on_member_update_abc
@ -243,7 +244,7 @@ cpl\_discord.events.on\_member\_update\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_message\_abc
cpl\_discord.events.on\_message\_abc module
-------------------------------------------
.. automodule:: cpl_discord.events.on_message_abc
@ -251,7 +252,7 @@ cpl\_discord.events.on\_message\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_message\_delete\_abc
cpl\_discord.events.on\_message\_delete\_abc module
---------------------------------------------------
.. automodule:: cpl_discord.events.on_message_delete_abc
@ -259,7 +260,7 @@ cpl\_discord.events.on\_message\_delete\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_message\_edit\_abc
cpl\_discord.events.on\_message\_edit\_abc module
-------------------------------------------------
.. automodule:: cpl_discord.events.on_message_edit_abc
@ -267,7 +268,7 @@ cpl\_discord.events.on\_message\_edit\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_private\_channel\_create\_abc
cpl\_discord.events.on\_private\_channel\_create\_abc module
------------------------------------------------------------
.. automodule:: cpl_discord.events.on_private_channel_create_abc
@ -275,7 +276,7 @@ cpl\_discord.events.on\_private\_channel\_create\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_private\_channel\_delete\_abc
cpl\_discord.events.on\_private\_channel\_delete\_abc module
------------------------------------------------------------
.. automodule:: cpl_discord.events.on_private_channel_delete_abc
@ -283,7 +284,7 @@ cpl\_discord.events.on\_private\_channel\_delete\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_private\_channel\_pins\_update\_abc
cpl\_discord.events.on\_private\_channel\_pins\_update\_abc module
------------------------------------------------------------------
.. automodule:: cpl_discord.events.on_private_channel_pins_update_abc
@ -291,7 +292,7 @@ cpl\_discord.events.on\_private\_channel\_pins\_update\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_private\_channel\_update\_abc
cpl\_discord.events.on\_private\_channel\_update\_abc module
------------------------------------------------------------
.. automodule:: cpl_discord.events.on_private_channel_update_abc
@ -299,7 +300,7 @@ cpl\_discord.events.on\_private\_channel\_update\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_raw\_reaction\_add\_abc
cpl\_discord.events.on\_raw\_reaction\_add\_abc module
------------------------------------------------------
.. automodule:: cpl_discord.events.on_raw_reaction_add_abc
@ -307,7 +308,7 @@ cpl\_discord.events.on\_raw\_reaction\_add\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_raw\_reaction\_clear\_abc
cpl\_discord.events.on\_raw\_reaction\_clear\_abc module
--------------------------------------------------------
.. automodule:: cpl_discord.events.on_raw_reaction_clear_abc
@ -315,7 +316,7 @@ cpl\_discord.events.on\_raw\_reaction\_clear\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_raw\_reaction\_clear\_emoji\_abc
cpl\_discord.events.on\_raw\_reaction\_clear\_emoji\_abc module
---------------------------------------------------------------
.. automodule:: cpl_discord.events.on_raw_reaction_clear_emoji_abc
@ -323,7 +324,7 @@ cpl\_discord.events.on\_raw\_reaction\_clear\_emoji\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_raw\_reaction\_remove\_abc
cpl\_discord.events.on\_raw\_reaction\_remove\_abc module
---------------------------------------------------------
.. automodule:: cpl_discord.events.on_raw_reaction_remove_abc
@ -331,7 +332,7 @@ cpl\_discord.events.on\_raw\_reaction\_remove\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_reaction\_add\_abc
cpl\_discord.events.on\_reaction\_add\_abc module
-------------------------------------------------
.. automodule:: cpl_discord.events.on_reaction_add_abc
@ -339,7 +340,7 @@ cpl\_discord.events.on\_reaction\_add\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_reaction\_clear\_abc
cpl\_discord.events.on\_reaction\_clear\_abc module
---------------------------------------------------
.. automodule:: cpl_discord.events.on_reaction_clear_abc
@ -347,7 +348,7 @@ cpl\_discord.events.on\_reaction\_clear\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_reaction\_clear\_emoji\_abc
cpl\_discord.events.on\_reaction\_clear\_emoji\_abc module
----------------------------------------------------------
.. automodule:: cpl_discord.events.on_reaction_clear_emoji_abc
@ -355,7 +356,7 @@ cpl\_discord.events.on\_reaction\_clear\_emoji\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_reaction\_remove\_abc
cpl\_discord.events.on\_reaction\_remove\_abc module
----------------------------------------------------
.. automodule:: cpl_discord.events.on_reaction_remove_abc
@ -363,7 +364,7 @@ cpl\_discord.events.on\_reaction\_remove\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_ready\_abc
cpl\_discord.events.on\_ready\_abc module
-----------------------------------------
.. automodule:: cpl_discord.events.on_ready_abc
@ -371,7 +372,7 @@ cpl\_discord.events.on\_ready\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_resume\_abc
cpl\_discord.events.on\_resume\_abc module
------------------------------------------
.. automodule:: cpl_discord.events.on_resume_abc
@ -379,7 +380,7 @@ cpl\_discord.events.on\_resume\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_typing\_abc
cpl\_discord.events.on\_typing\_abc module
------------------------------------------
.. automodule:: cpl_discord.events.on_typing_abc
@ -387,7 +388,7 @@ cpl\_discord.events.on\_typing\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_user\_update\_abc
cpl\_discord.events.on\_user\_update\_abc module
------------------------------------------------
.. automodule:: cpl_discord.events.on_user_update_abc
@ -395,7 +396,7 @@ cpl\_discord.events.on\_user\_update\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_voice\_state\_update\_abc
cpl\_discord.events.on\_voice\_state\_update\_abc module
--------------------------------------------------------
.. automodule:: cpl_discord.events.on_voice_state_update_abc
@ -403,10 +404,18 @@ cpl\_discord.events.on\_voice\_state\_update\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.events.on\_webhooks\_update\_abc
cpl\_discord.events.on\_webhooks\_update\_abc module
----------------------------------------------------
.. automodule:: cpl_discord.events.on_webhooks_update_abc
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_discord.events
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,12 +1,21 @@
cpl\_discord.helper
cpl\_discord.helper package
===========================
Submodules
----------
cpl\_discord.helper.to\_containers\_converter
cpl\_discord.helper.to\_containers\_converter module
----------------------------------------------------
.. automodule:: cpl_discord.helper.to_containers_converter
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_discord.helper
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,6 +1,9 @@
Discord reference
cpl\_discord package
====================
Subpackages
-----------
.. toctree::
:maxdepth: 4
@ -11,3 +14,22 @@ Discord reference
cpl_discord.events
cpl_discord.helper
cpl_discord.service
Submodules
----------
cpl\_discord.discord\_event\_types\_enum module
-----------------------------------------------
.. automodule:: cpl_discord.discord_event_types_enum
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_discord
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,9 +1,10 @@
cpl\_discord.service
cpl\_discord.service package
============================
Submodules
----------
cpl\_discord.service.command\_error\_handler\_service
cpl\_discord.service.command\_error\_handler\_service module
------------------------------------------------------------
.. automodule:: cpl_discord.service.command_error_handler_service
@ -11,7 +12,7 @@ cpl\_discord.service.command\_error\_handler\_service
:undoc-members:
:show-inheritance:
cpl\_discord.service.discord\_bot\_service
cpl\_discord.service.discord\_bot\_service module
-------------------------------------------------
.. automodule:: cpl_discord.service.discord_bot_service
@ -19,7 +20,7 @@ cpl\_discord.service.discord\_bot\_service
:undoc-members:
:show-inheritance:
cpl\_discord.service.discord\_bot\_service\_abc
cpl\_discord.service.discord\_bot\_service\_abc module
------------------------------------------------------
.. automodule:: cpl_discord.service.discord_bot_service_abc
@ -27,7 +28,7 @@ cpl\_discord.service.discord\_bot\_service\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.service.discord\_collection
cpl\_discord.service.discord\_collection module
-----------------------------------------------
.. automodule:: cpl_discord.service.discord_collection
@ -35,7 +36,7 @@ cpl\_discord.service.discord\_collection
:undoc-members:
:show-inheritance:
cpl\_discord.service.discord\_collection\_abc
cpl\_discord.service.discord\_collection\_abc module
----------------------------------------------------
.. automodule:: cpl_discord.service.discord_collection_abc
@ -43,7 +44,7 @@ cpl\_discord.service.discord\_collection\_abc
:undoc-members:
:show-inheritance:
cpl\_discord.service.discord\_service
cpl\_discord.service.discord\_service module
--------------------------------------------
.. automodule:: cpl_discord.service.discord_service
@ -51,10 +52,18 @@ cpl\_discord.service.discord\_service
:undoc-members:
:show-inheritance:
cpl\_discord.service.discord\_service\_abc
cpl\_discord.service.discord\_service\_abc module
-------------------------------------------------
.. automodule:: cpl_discord.service.discord_service_abc
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_discord.service
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,9 +1,10 @@
cpl\_query.base
cpl\_query.base package
=======================
Submodules
----------
cpl\_query.base.default\_lambda
cpl\_query.base.default\_lambda module
--------------------------------------
.. automodule:: cpl_query.base.default_lambda
@ -11,7 +12,7 @@ cpl\_query.base.default\_lambda
:undoc-members:
:show-inheritance:
cpl\_query.base.ordered\_queryable
cpl\_query.base.ordered\_queryable module
-----------------------------------------
.. automodule:: cpl_query.base.ordered_queryable
@ -19,7 +20,7 @@ cpl\_query.base.ordered\_queryable
:undoc-members:
:show-inheritance:
cpl\_query.base.ordered\_queryable\_abc
cpl\_query.base.ordered\_queryable\_abc module
----------------------------------------------
.. automodule:: cpl_query.base.ordered_queryable_abc
@ -27,7 +28,7 @@ cpl\_query.base.ordered\_queryable\_abc
:undoc-members:
:show-inheritance:
cpl\_query.base.queryable\_abc
cpl\_query.base.queryable\_abc module
-------------------------------------
.. automodule:: cpl_query.base.queryable_abc
@ -35,18 +36,18 @@ cpl\_query.base.queryable\_abc
:undoc-members:
:show-inheritance:
cpl\_query.base.sequence\_abc
------------------------------------
cpl\_query.base.sequence module
-------------------------------
.. automodule:: cpl_query.base.sequence_abc
.. automodule:: cpl_query.base.sequence
:members:
:undoc-members:
:show-inheritance:
cpl\_query.base.sequence\_values
---------------------------------------
Module contents
---------------
.. automodule:: cpl_query.base.sequence_values
.. automodule:: cpl_query.base
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,9 +1,10 @@
cpl\_query.enumerable
cpl\_query.enumerable package
=============================
Submodules
----------
cpl\_query.enumerable.enumerable
cpl\_query.enumerable.enumerable module
---------------------------------------
.. automodule:: cpl_query.enumerable.enumerable
@ -11,10 +12,18 @@ cpl\_query.enumerable.enumerable
:undoc-members:
:show-inheritance:
cpl\_query.enumerable.enumerable\_abc
cpl\_query.enumerable.enumerable\_abc module
--------------------------------------------
.. automodule:: cpl_query.enumerable.enumerable_abc
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_query.enumerable
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,12 +1,21 @@
cpl\_query.extension
cpl\_query.extension package
============================
Submodules
----------
cpl\_query.extension.list
cpl\_query.extension.list module
--------------------------------
.. automodule:: cpl_query.extension.list
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_query.extension
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,9 +1,10 @@
cpl\_query.iterable
cpl\_query.iterable package
===========================
Submodules
----------
cpl\_query.iterable.iterable
cpl\_query.iterable.iterable module
-----------------------------------
.. automodule:: cpl_query.iterable.iterable
@ -11,10 +12,18 @@ cpl\_query.iterable.iterable
:undoc-members:
:show-inheritance:
cpl\_query.iterable.iterable\_abc
cpl\_query.iterable.iterable\_abc module
----------------------------------------
.. automodule:: cpl_query.iterable.iterable_abc
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_query.iterable
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,10 +1,10 @@
Query reference
===========
===============
.. toctree::
:maxdepth: 4
cpl_query.base
cpl_query.enumerable
cpl_query.extension
cpl_query.iterable
cpl_query.base
cpl_query.enumerable
cpl_query.extension
cpl_query.iterable

View File

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

View File

@ -1,10 +1,9 @@
cpl
===
Packages
========
.. toctree::
:maxdepth: 4
getting_started
cpl_cli
cpl_core
cpl_discord

View File

@ -104,8 +104,8 @@ Hello World
## What's next
- To learn more about the CPL CLI, see the [CLI Overview](cli.overview)
- Fore more informations about the Pyhton files generated by ```cpl new```, see [New Command](cli.new)
- To learn more about the CPL CLI, see the [CLI Overview](cpl_cli.overview)
- Fore more informations about the Pyhton files generated by ```cpl new```, see [New Command](cpl_cli.new)
<!-- LINKS -->
[pip-url]: https://pip.sh-edraft.de

View File

@ -59,7 +59,7 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">cpl_discord package</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
</ul>
@ -127,7 +127,7 @@
<li><p>Be sure that an issue describes the problem youre fixing, or documents the design for the feature youd like to add. Discussing the design upfront helps to ensure that were ready to accept your work.</p></li>
<li><p>Fork the sh-edraft.de/cpl repo.</p></li>
<li><p>In your forked repository, make your changes in a new git branch:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git checkout -b my-fix-branch master
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>my-fix-branch<span class="w"> </span>master
</pre></div>
</div>
</li>
@ -136,13 +136,13 @@
<!-- 6. Follow our [Coding Rules](coding-rules). -->
<ol class="arabic" start="6">
<li><p>Commit your changes.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git commit --all
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>commit<span class="w"> </span>--all
</pre></div>
</div>
<p>Note: the optional commit <code class="docutils literal notranslate"><span class="pre">-a</span></code> command line option will automatically “add” and “rm” edited files.</p>
</li>
<li><p>Push your branch to the <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">repository</a>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git push origin my-fix-branch
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>my-fix-branch
</pre></div>
</div>
</li>
@ -158,8 +158,8 @@
<ol class="arabic">
<li><p>Make the required updates to the code.</p></li>
<li><p>Create a fixup commit and push to your repository (this will update your Pull Request):</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git commit --all --fixup HEAD
git push
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>commit<span class="w"> </span>--all<span class="w"> </span>--fixup<span class="w"> </span>HEAD
git<span class="w"> </span>push
</pre></div>
</div>
</li>

View File

@ -19,8 +19,8 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl build" href="cli.build.html" />
<link rel="prev" title="CLI Overview and Command Reference" href="cli.overview.html" />
<link rel="next" title="cpl build" href="cpl_cli.build.html" />
<link rel="prev" title="CLI Overview and Command Reference" href="cpl_cli.overview.html" />
</head>
<body class="wy-body-for-nav">
@ -43,7 +43,7 @@
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl add</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
@ -51,21 +51,22 @@
<li class="toctree-l3"><a class="reference internal" href="#flags">Flags</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.run.html">cpl run</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">cpl_discord package</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
</ul>
@ -87,7 +88,7 @@
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl add</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.add.md.txt" rel="nofollow"> View page source</a>
<a href="_sources/cpl_cli.add.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
@ -156,8 +157,8 @@ cpl <strong>A</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.overview.html" class="btn btn-neutral float-left" title="CLI Overview and Command Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cli.build.html" class="btn btn-neutral float-right" title="cpl build" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_cli.overview.html" class="btn btn-neutral float-left" title="CLI Overview and Command Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cpl_cli.build.html" class="btn btn-neutral float-right" title="cpl build" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>

View File

@ -19,8 +19,8 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl generate" href="cli.generate.html" />
<link rel="prev" title="cpl add" href="cli.add.html" />
<link rel="next" title="cpl generate" href="cpl_cli.generate.html" />
<link rel="prev" title="cpl add" href="cpl_cli.add.html" />
</head>
<body class="wy-body-for-nav">
@ -43,27 +43,28 @@
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl build</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.run.html">cpl run</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">cpl_discord package</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
</ul>
@ -85,7 +86,7 @@
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl build</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.build.md.txt" rel="nofollow"> View page source</a>
<a href="_sources/cpl_cli.build.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
@ -123,8 +124,8 @@ cpl <strong>B</strong></p>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.add.html" class="btn btn-neutral float-left" title="cpl add" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cli.generate.html" class="btn btn-neutral float-right" title="cpl generate" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_cli.add.html" class="btn btn-neutral float-left" title="cpl add" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cpl_cli.generate.html" class="btn btn-neutral float-right" title="cpl generate" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>

View File

@ -19,8 +19,8 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl help" href="cli.help.html" />
<link rel="prev" title="cpl build" href="cli.build.html" />
<link rel="next" title="cpl help" href="cpl_cli.help.html" />
<link rel="prev" title="cpl build" href="cpl_cli.build.html" />
</head>
<body class="wy-body-for-nav">
@ -43,9 +43,9 @@
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.build.html">cpl build</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl generate</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
@ -53,19 +53,20 @@
<li class="toctree-l3"><a class="reference internal" href="#schematics">Schematics</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.run.html">cpl run</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">cpl_discord package</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
</ul>
@ -87,7 +88,7 @@
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl generate</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.generate.md.txt" rel="nofollow"> View page source</a>
<a href="_sources/cpl_cli.generate.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
@ -202,8 +203,8 @@ cpl <strong>G</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em></p>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.build.html" class="btn btn-neutral float-left" title="cpl build" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cli.help.html" class="btn btn-neutral float-right" title="cpl help" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_cli.build.html" class="btn btn-neutral float-left" title="cpl build" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cpl_cli.help.html" class="btn btn-neutral float-right" title="cpl help" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>

View File

@ -19,8 +19,8 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl install" href="cli.install.html" />
<link rel="prev" title="cpl generate" href="cli.generate.html" />
<link rel="next" title="cpl install" href="cpl_cli.install.html" />
<link rel="prev" title="cpl generate" href="cpl_cli.generate.html" />
</head>
<body class="wy-body-for-nav">
@ -43,28 +43,29 @@
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.generate.html">cpl generate</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl help</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.run.html">cpl run</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">cpl_discord package</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
</ul>
@ -86,7 +87,7 @@
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl help</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cli.help.md.txt" rel="nofollow"> View page source</a>
<a href="_sources/cpl_cli.help.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
@ -134,8 +135,8 @@ cpl <strong>H</strong> <em>&lt;command&gt;</em></p>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cli.generate.html" class="btn btn-neutral float-left" title="cpl generate" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cli.install.html" class="btn btn-neutral float-right" title="cpl install" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_cli.generate.html" class="btn btn-neutral float-left" title="cpl generate" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cpl_cli.install.html" class="btn btn-neutral float-right" title="cpl install" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>

View File

@ -19,7 +19,7 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="CLI Overview and Command Reference" href="cli.overview.html" />
<link rel="next" title="CLI Overview and Command Reference" href="cpl_cli.overview.html" />
<link rel="prev" title="Contributing to CPL" href="contributing.html" />
</head>
@ -43,23 +43,24 @@
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">CLI reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.build.html">cpl build</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.generate.html">cpl generate</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.help.html">cpl help</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.install.html">cpl install</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.new.html">cpl new</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html">cpl publish</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.remove.html">cpl remove</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.run.html">cpl run</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.start.html">cpl start</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.uninstall.html">cpl uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">cpl_discord package</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
</ul>
@ -92,81 +93,82 @@
<h1>CLI reference<a class="headerlink" href="#cli-reference" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html#table-of-contents">Table of Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html#basic-workflow">Basic workflow</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html#cli-command-language-syntax">CLI command-language syntax</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.overview.html#relative-paths">Relative paths</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.overview.html#schematics">Schematics</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html#table-of-contents">Table of Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html#basic-workflow">Basic workflow</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html#cli-command-language-syntax">CLI command-language syntax</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.overview.html#relative-paths">Relative paths</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_cli.overview.html#schematics">Schematics</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html#command-overview">Command overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html#command-overview">Command overview</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.add.html">cpl add</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html#arguments">Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.add.html#flags">Flags</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.add.html">cpl add</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html#arguments">Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html#flags">Flags</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.build.html">cpl build</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html#description">Description</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.build.html">cpl build</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.build.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.build.html#description">Description</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.generate.html">cpl generate</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html#arguments">Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html#schematics">Schematics</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.generate.html">cpl generate</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.generate.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.generate.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.generate.html#arguments">Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.generate.html#schematics">Schematics</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.help.html">cpl help</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.help.html#arguments">Arguments</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.help.html">cpl help</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.help.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.help.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.help.html#arguments">Arguments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.install.html">cpl install</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html#arguments">Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.install.html#flags">Flags</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.install.html">cpl install</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.install.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.install.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.install.html#arguments">Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.install.html#flags">Flags</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.new.html">cpl new</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html#project-types">Project types</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html#flags">Flags</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.new.html">cpl new</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.new.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.new.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.new.html#project-types">Project types</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.new.html#flags">Flags</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.publish.html">cpl publish</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html#description">Description</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.publish.html">cpl publish</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.publish.html#description">Description</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.remove.html">cpl remove</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html#arguments">Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html#flags">Flags</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.remove.html">cpl remove</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.remove.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.remove.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.remove.html#arguments">Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.remove.html#flags">Flags</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.start.html">cpl start</a></li>
<li class="toctree-l1"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html#arguments">Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html#flags">Flags</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.run.html">cpl run</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.start.html">cpl start</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.uninstall.html">cpl uninstall</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.uninstall.html#contents">Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.uninstall.html#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.uninstall.html#arguments">Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.uninstall.html#flags">Flags</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.update.html">cpl update</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html#flags">Flags</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.update.html">cpl update</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.update.html#flags">Flags</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.version.html">cpl version</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
</ul>
</div>
</section>
@ -176,7 +178,7 @@
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="contributing.html" class="btn btn-neutral float-left" title="Contributing to CPL" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cli.overview.html" class="btn btn-neutral float-right" title="CLI Overview and Command Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl_cli.overview.html" class="btn btn-neutral float-right" title="CLI Overview and Command Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>

Some files were not shown because too many files have changed in this diff Show More