Updated docs
This commit is contained in:
@@ -18,10 +18,11 @@ Generates files based on a schematic.
|
||||
|
||||
## Arguments
|
||||
|
||||
| Argument | Description | Value type |
|
||||
| ----------------- |:---------------------------------:|:-------------:|
|
||||
| ```<schematic>``` | The schematic to generate. | ```str``` |
|
||||
| ```<name>``` | The name of the generated file. | ```str``` |
|
||||
| Argument | Description | Value type |
|
||||
|-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------:|
|
||||
| ```<schematic>``` | The schematic to generate. | ```str``` |
|
||||
| ```<name>``` | The name of the generated file. | ```str``` |
|
||||
| ```--base``` | First element of path will be used as base-path not 'src'. For example: 'cpl g c test/Test' will be created at ```src/test/``` with --base it would be ```test/``` | ```str``` |
|
||||
|
||||
## Schematics
|
||||
|
||||
|
@@ -18,10 +18,11 @@ Generates a workspace and initial project or add a project to workspace.
|
||||
|
||||
If the command is running in a CPL workspace, it will add the new project to the workspace.
|
||||
|
||||
| Argument | Description | Value type |
|
||||
|--------------|:----------------------------------------------------:|:----------:|
|
||||
| ```<type>``` | The type of the project, see [types](#project-types) | ```str``` |
|
||||
| ```<name>``` | The name of the project | ```str``` |
|
||||
| Argument | Description | Value type |
|
||||
|--------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------:|
|
||||
| ```<type>``` | The type of the project, see [types](#project-types) | ```str``` |
|
||||
| ```<name>``` | The name of the project | ```str``` |
|
||||
| ```--base``` | First element of path will be used as base-path not 'src'. For example: 'cpl g c test/Test' will be created at ```src/test/``` with --base it would be ```test/``` | ```str``` |
|
||||
|
||||
## Project types
|
||||
|
||||
|
12
docs/source/cli.run.md
Normal file
12
docs/source/cli.run.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# cpl run
|
||||
|
||||
Starts your application once.
|
||||
|
||||
cpl **run** <br>
|
||||
cpl **r** <br>
|
||||
cpl **R**
|
||||
|
||||
| Argument | Description | Value type |
|
||||
|-----------------|:----------------------------------------------------------------------------------------------------:|:----------:|
|
||||
| ```<project>``` | Optional parameter to specify which project to start, if not set default project will be started. | ```str``` |
|
||||
| ```--dev``` | To run the project from source and not from dist after build. | ```str``` |
|
@@ -5,3 +5,7 @@ Starts your application, restarting on file changes.
|
||||
cpl **start** <br>
|
||||
cpl **s** <br>
|
||||
cpl **S**
|
||||
|
||||
| Argument | Description | Value type |
|
||||
|-----------------|:----------------------------------------------------------------------------------------------------:|:----------:|
|
||||
| ```--dev``` | To run the project from source and not from dist after build. | ```str``` |
|
@@ -15,16 +15,15 @@
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
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, Sven Heidemann'
|
||||
copyright = '2021 - 2023, Sven Heidemann'
|
||||
author = 'Sven Heidemann'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension names here, as strings. They can be
|
||||
@@ -56,7 +55,6 @@ exclude_patterns = [
|
||||
'tests/*'
|
||||
]
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
|
@@ -1,4 +1,4 @@
|
||||
CLI Reference
|
||||
CLI reference
|
||||
=============
|
||||
|
||||
.. toctree::
|
||||
|
@@ -7,8 +7,7 @@ cpl_core.database
|
||||
cpl_core.database.connection
|
||||
cpl_core.database.context
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
|
||||
cpl_core.database.database\_model
|
||||
-----------------------------------
|
||||
|
@@ -1,10 +1,9 @@
|
||||
cpl\_core.pipes
|
||||
=======================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
cpl\_core.pipes.bool\_pipe module
|
||||
|
||||
cpl\_core.pipes.bool\_pipe
|
||||
---------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.bool_pipe
|
||||
@@ -12,7 +11,7 @@ cpl\_core.pipes.bool\_pipe module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_core.pipes.first\_char\_to\_lower\_pipe module
|
||||
cpl\_core.pipes.first\_char\_to\_lower\_pipe
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.first_char_to_lower_pipe
|
||||
@@ -20,7 +19,7 @@ cpl\_core.pipes.first\_char\_to\_lower\_pipe module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_core.pipes.first\_to\_upper\_pipe module
|
||||
cpl\_core.pipes.first\_to\_upper\_pipe
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.first_to_upper_pipe
|
||||
@@ -28,7 +27,7 @@ cpl\_core.pipes.first\_to\_upper\_pipe module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_core.pipes.ip\_address\_pipe module
|
||||
cpl\_core.pipes.ip\_address\_pipe
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.ip_address_pipe
|
||||
@@ -36,7 +35,7 @@ cpl\_core.pipes.ip\_address\_pipe module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_core.pipes.pipe\_abc module
|
||||
cpl\_core.pipes.pipe\_abc
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.pipe_abc
|
||||
@@ -44,7 +43,7 @@ cpl\_core.pipes.pipe\_abc module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_core.pipes.to\_camel\_case\_pipe module
|
||||
cpl\_core.pipes.to\_camel\_case\_pipe
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.to_camel_case_pipe
|
||||
@@ -52,7 +51,7 @@ cpl\_core.pipes.to\_camel\_case\_pipe module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_core.pipes.to\_snake\_case\_pipe module
|
||||
cpl\_core.pipes.to\_snake\_case\_pipe
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.to_snake_case_pipe
|
||||
@@ -60,18 +59,10 @@ cpl\_core.pipes.to\_snake\_case\_pipe module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_core.pipes.version\_pipe module
|
||||
cpl\_core.pipes.version\_pipe
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.version_pipe
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_core.pipes
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
@@ -1,4 +1,4 @@
|
||||
API Reference
|
||||
API reference
|
||||
===========
|
||||
|
||||
.. toctree::
|
||||
|
12
docs/source/cpl_discord.application.rst
Normal file
12
docs/source/cpl_discord.application.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
cpl\_discord.application
|
||||
================================
|
||||
|
||||
|
||||
|
||||
cpl\_discord.application.discord\_bot\_application\_abc
|
||||
--------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.application.discord_bot_application_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
20
docs/source/cpl_discord.command.rst
Normal file
20
docs/source/cpl_discord.command.rst
Normal file
@@ -0,0 +1,20 @@
|
||||
cpl\_discord.command
|
||||
============================
|
||||
|
||||
|
||||
|
||||
cpl\_discord.command.discord\_command\_abc
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.command.discord_command_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.command.discord\_commands\_meta
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.command.discord_commands_meta
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
12
docs/source/cpl_discord.configuration.rst
Normal file
12
docs/source/cpl_discord.configuration.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
cpl\_discord.configuration
|
||||
==================================
|
||||
|
||||
|
||||
|
||||
cpl\_discord.configuration.discord\_bot\_settings
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.configuration.discord_bot_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
68
docs/source/cpl_discord.container.rst
Normal file
68
docs/source/cpl_discord.container.rst
Normal file
@@ -0,0 +1,68 @@
|
||||
cpl\_discord.container
|
||||
==============================
|
||||
|
||||
|
||||
|
||||
cpl\_discord.container.category\_channel
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.container.category_channel
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.container.container
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.container.container
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.container.guild
|
||||
-----------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.container.guild
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.container.member
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.container.member
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.container.role
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.container.role
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.container.text\_channel
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.container.text_channel
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.container.thread
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.container.thread
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.container.voice\_channel
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.container.voice_channel
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
412
docs/source/cpl_discord.events.rst
Normal file
412
docs/source/cpl_discord.events.rst
Normal file
@@ -0,0 +1,412 @@
|
||||
cpl\_discord.events
|
||||
===========================
|
||||
|
||||
|
||||
|
||||
cpl\_discord.events.on\_bulk\_message\_delete\_abc
|
||||
---------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_bulk_message_delete_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_command\_abc
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_command_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_command\_completion\_abc
|
||||
-------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_command_completion_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_command\_error\_abc
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_command_error_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_connect\_abc
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_connect_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_disconnect\_abc
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_disconnect_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_error\_abc
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_error_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_group\_join\_abc
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_group_join_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_group\_remove\_abc
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_group_remove_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_available\_abc
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_available_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_channel\_create\_abc
|
||||
----------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_channel_create_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_channel\_delete\_abc
|
||||
----------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_channel_delete_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_channel\_pins\_update\_abc
|
||||
----------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_channel_pins_update_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_channel\_update\_abc
|
||||
----------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_channel_update_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_emojis\_update\_abc
|
||||
---------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_emojis_update_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_integrations\_update\_abc
|
||||
---------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_integrations_update_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_join\_abc
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_join_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_remove\_abc
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_remove_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_role\_create\_abc
|
||||
-------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_role_create_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_role\_delete\_abc
|
||||
-------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_role_delete_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_role\_update\_abc
|
||||
-------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_role_update_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_unavailable\_abc
|
||||
------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_unavailable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_guild\_update\_abc
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_guild_update_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_invite\_create\_abc
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_invite_create_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_invite\_delete\_abc
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_invite_delete_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_member\_ban\_abc
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_member_ban_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_member\_join\_abc
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_member_join_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_member\_remove\_abc
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_member_remove_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_member\_unban\_abc
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_member_unban_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_member\_update\_abc
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_member_update_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_message\_abc
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_message_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_message\_delete\_abc
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_message_delete_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_message\_edit\_abc
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_message_edit_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_private\_channel\_create\_abc
|
||||
------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_private_channel_create_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_private\_channel\_delete\_abc
|
||||
------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_private_channel_delete_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_private\_channel\_pins\_update\_abc
|
||||
------------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_private_channel_pins_update_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_private\_channel\_update\_abc
|
||||
------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_private_channel_update_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_raw\_reaction\_add\_abc
|
||||
------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_raw_reaction_add_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_raw\_reaction\_clear\_abc
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_raw_reaction_clear_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_raw\_reaction\_clear\_emoji\_abc
|
||||
---------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_raw_reaction_clear_emoji_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_raw\_reaction\_remove\_abc
|
||||
---------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_raw_reaction_remove_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_reaction\_add\_abc
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_reaction_add_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_reaction\_clear\_abc
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_reaction_clear_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_reaction\_clear\_emoji\_abc
|
||||
----------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_reaction_clear_emoji_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_reaction\_remove\_abc
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_reaction_remove_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_ready\_abc
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_ready_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_resume\_abc
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_resume_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_typing\_abc
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_typing_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_user\_update\_abc
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_user_update_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_voice\_state\_update\_abc
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_voice_state_update_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.events.on\_webhooks\_update\_abc
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.events.on_webhooks_update_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
12
docs/source/cpl_discord.helper.rst
Normal file
12
docs/source/cpl_discord.helper.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
cpl\_discord.helper
|
||||
===========================
|
||||
|
||||
|
||||
|
||||
cpl\_discord.helper.to\_containers\_converter
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.helper.to_containers_converter
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
13
docs/source/cpl_discord.rst
Normal file
13
docs/source/cpl_discord.rst
Normal file
@@ -0,0 +1,13 @@
|
||||
Discord reference
|
||||
====================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
cpl_discord.application
|
||||
cpl_discord.command
|
||||
cpl_discord.configuration
|
||||
cpl_discord.container
|
||||
cpl_discord.events
|
||||
cpl_discord.helper
|
||||
cpl_discord.service
|
60
docs/source/cpl_discord.service.rst
Normal file
60
docs/source/cpl_discord.service.rst
Normal file
@@ -0,0 +1,60 @@
|
||||
cpl\_discord.service
|
||||
============================
|
||||
|
||||
|
||||
|
||||
cpl\_discord.service.command\_error\_handler\_service
|
||||
------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.service.command_error_handler_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.service.discord\_bot\_service
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.service.discord_bot_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.service.discord\_bot\_service\_abc
|
||||
------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.service.discord_bot_service_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.service.discord\_collection
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.service.discord_collection
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.service.discord\_collection\_abc
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.service.discord_collection_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.service.discord\_service
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.service.discord_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_discord.service.discord\_service\_abc
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_discord.service.discord_service_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
52
docs/source/cpl_query.base.rst
Normal file
52
docs/source/cpl_query.base.rst
Normal file
@@ -0,0 +1,52 @@
|
||||
cpl\_query.base
|
||||
=======================
|
||||
|
||||
|
||||
|
||||
cpl\_query.base.default\_lambda
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.base.default_lambda
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_query.base.ordered\_queryable
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.base.ordered_queryable
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_query.base.ordered\_queryable\_abc
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.base.ordered_queryable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_query.base.queryable\_abc
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.base.queryable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_query.base.sequence\_abc
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.base.sequence_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_query.base.sequence\_values
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.base.sequence_values
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
20
docs/source/cpl_query.enumerable.rst
Normal file
20
docs/source/cpl_query.enumerable.rst
Normal file
@@ -0,0 +1,20 @@
|
||||
cpl\_query.enumerable
|
||||
=============================
|
||||
|
||||
|
||||
|
||||
cpl\_query.enumerable.enumerable
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.enumerable.enumerable
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_query.enumerable.enumerable\_abc
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.enumerable.enumerable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
@@ -1,10 +0,0 @@
|
||||
cpl_query.exceptions
|
||||
=================================
|
||||
|
||||
cpl_query.exceptions
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.exceptions
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
@@ -1,42 +1,12 @@
|
||||
cpl_query.extension
|
||||
=================================
|
||||
cpl\_query.extension
|
||||
============================
|
||||
|
||||
cpl_query.extension.iterable_abc
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.extension.iterable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl_query.extension.iterable
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.extension.iterable
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl_query.extension.list
|
||||
----------------------------------------------------
|
||||
cpl\_query.extension.list
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: cpl_query.extension.list
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl_query.extension.ordered_iterable_abc
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.extension.ordered_iterable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl_query.extension.ordered_iterable
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.extension.ordered_iterable
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
20
docs/source/cpl_query.iterable.rst
Normal file
20
docs/source/cpl_query.iterable.rst
Normal file
@@ -0,0 +1,20 @@
|
||||
cpl\_query.iterable
|
||||
===========================
|
||||
|
||||
|
||||
|
||||
cpl\_query.iterable.iterable
|
||||
-----------------------------------
|
||||
|
||||
.. automodule:: cpl_query.iterable.iterable
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_query.iterable.iterable\_abc
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.iterable.iterable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
@@ -1,8 +1,10 @@
|
||||
Query Reference
|
||||
Query reference
|
||||
===========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
cpl_query.extension
|
||||
cpl_query.exceptions
|
||||
|
||||
cpl_query.base
|
||||
cpl_query.enumerable
|
||||
cpl_query.extension
|
||||
cpl_query.iterable
|
||||
|
34
docs/source/cpl_translation.rst
Normal file
34
docs/source/cpl_translation.rst
Normal file
@@ -0,0 +1,34 @@
|
||||
Translation reference
|
||||
========================
|
||||
|
||||
cpl\_translation.translate\_pipe
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: cpl_translation.translate_pipe
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_translation.translation\_service
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_translation.translation_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_translation.translation\_service\_abc
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_translation.translation_service_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
cpl\_translation.translation\_settings
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: cpl_translation.translation_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
@@ -89,4 +89,6 @@ These pages go into great detail about everything the Library can do.
|
||||
contributing
|
||||
cpl_cli
|
||||
cpl_core
|
||||
cpl_discord
|
||||
cpl_query
|
||||
cpl_translation
|
||||
|
@@ -9,4 +9,4 @@ cpl
|
||||
cpl_core
|
||||
cpl_discord
|
||||
cpl_query
|
||||
cpl_translate
|
||||
cpl_translation
|
||||
|
Reference in New Issue
Block a user