sh-edraft.de/sh_cpl
2
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects 1 Releases 12 Wiki Activity

Updated docs

Browse Source
This commit is contained in:
Sven Heidemann
2023-02-20 15:55:20 +01:00
parent 48d0daabf5
commit 9e28dce5ce
632 changed files with 10917 additions and 6775 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/source/conf.py
View File

@@ -16,13 +16,13 @@
import os
import sys
sys.path.insert(0, os.path.abspath('../../src/'))
sys.path.insert(0, os.path.abspath("../../src/"))
# -- Project information -----------------------------------------------------
project = 'Common Python Library'
copyright = '2021 - 2023, Sven Heidemann'
author = 'Sven Heidemann'
project = "Common Python Library"
copyright = "2021 - 2023, Sven Heidemann"
author = "Sven Heidemann"
# -- General configuration ---------------------------------------------------
@@ -30,39 +30,33 @@ author = 'Sven Heidemann'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx_rtd_theme',
'myst_parser'
"sphinx.ext.autodoc",
"sphinx_rtd_theme",
"myst_parser",
]
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
".md": "markdown",
".txt": "markdown",
".rst": "restructuredtext",
}
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
'cpl_cli/templates/*',
'cpl_cli/*',
'tests',
'cpl_query/tests/*',
'tests/*'
]
exclude_patterns = ["cpl_cli/templates/*", "cpl_cli/*", "tests", "cpl_query/tests/*", "tests/*"]
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'
html_theme = "sphinx_rtd_theme"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ["_static"]

2
docs/source/cli.add.md → docs/source/cpl_cli.add.md
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 |

0
docs/source/cli.build.md → docs/source/cpl_cli.build.md
View File

0
docs/source/cli.generate.md → docs/source/cpl_cli.generate.md
View File

0
docs/source/cli.help.md → docs/source/cpl_cli.help.md
View File

0
docs/source/cli.install.md → docs/source/cpl_cli.install.md
View File

0
docs/source/cli.new.md → docs/source/cpl_cli.new.md
View File

24
docs/source/cli.overview.md → docs/source/cpl_cli.overview.md
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.

0
docs/source/cli.publish.md → docs/source/cpl_cli.publish.md
View File

0
docs/source/cli.remove.md → docs/source/cpl_cli.remove.md
View File

27
docs/source/cpl_cli.rst
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

0
docs/source/cli.run.md → docs/source/cpl_cli.run.md
View File

0
docs/source/cli.start.md → docs/source/cpl_cli.start.md
View File

0
docs/source/cli.uninstall.md → docs/source/cpl_cli.uninstall.md
View File

0
docs/source/cli.update.md → docs/source/cpl_cli.update.md
View File

0
docs/source/cli.version.md → docs/source/cpl_cli.version.md
View File

47
docs/source/cpl_core.application.rst
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:

93
docs/source/cpl_core.configuration.rst
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:

35
docs/source/cpl_core.console.rst
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:

23
docs/source/cpl_core.database.connection.rst
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:

23
docs/source/cpl_core.database.context.rst
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:

42
docs/source/cpl_core.database.rst
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:

63
docs/source/cpl_core.dependency_injection.rst
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:

27
docs/source/cpl_core.environment.rst
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:

35
docs/source/cpl_core.logging.rst
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:

35
docs/source/cpl_core.mailing.rst
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:

29
docs/source/cpl_core.pipes.rst
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:

3
docs/source/cpl_core.rst
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

23
docs/source/cpl_core.time.rst
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:

27
docs/source/cpl_core.utils.rst
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:

15
docs/source/cpl_discord.application.rst
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:

17
docs/source/cpl_discord.command.rst
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:

15
docs/source/cpl_discord.configuration.rst
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:

29
docs/source/cpl_discord.container.rst
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:

117
docs/source/cpl_discord.events.rst
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:

15
docs/source/cpl_discord.helper.rst
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:

24
docs/source/cpl_discord.rst
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:

27
docs/source/cpl_discord.service.rst
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:

25
docs/source/cpl_query.base.rst
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:

17
docs/source/cpl_query.enumerable.rst
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:

15
docs/source/cpl_query.extension.rst
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:

17
docs/source/cpl_query.iterable.rst
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:

10
docs/source/cpl_query.rst
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

2
docs/source/introduction.md
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)

5
docs/source/modules.rst
View File

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

4
docs/source/setup.md
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