Added first sphinx generated doc

This commit is contained in:
2021-04-14 10:45:39 +02:00
parent 80eb1da0e1
commit 478f1ad0ff
145 changed files with 29136 additions and 0 deletions

View File

@@ -0,0 +1,34 @@
cpl.application
=======================
cpl.application.application\_abc module
---------------------------------------
.. automodule:: cpl.application.application_abc
:members:
:undoc-members:
:show-inheritance:
cpl.application.application\_builder module
-------------------------------------------
.. automodule:: cpl.application.application_builder
:members:
:undoc-members:
:show-inheritance:
cpl.application.application\_builder\_abc module
------------------------------------------------
.. automodule:: cpl.application.application_builder_abc
:members:
:undoc-members:
:show-inheritance:
cpl.application.startup\_abc module
-----------------------------------
.. automodule:: cpl.application.startup_abc
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,42 @@
cpl.configuration
=========================
cpl.configuration.configuration module
--------------------------------------
.. automodule:: cpl.configuration.configuration
:members:
:undoc-members:
:show-inheritance:
cpl.configuration.configuration\_abc module
-------------------------------------------
.. automodule:: cpl.configuration.configuration_abc
:members:
:undoc-members:
:show-inheritance:
cpl.configuration.configuration\_model\_abc module
--------------------------------------------------
.. automodule:: cpl.configuration.configuration_model_abc
:members:
:undoc-members:
:show-inheritance:
cpl.configuration.configuration\_variable\_name\_enum module
------------------------------------------------------------
.. automodule:: cpl.configuration.configuration_variable_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl.configuration.console\_argument module
------------------------------------------
.. automodule:: cpl.configuration.console_argument
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,42 @@
cpl.console
===================
cpl.console.background\_color\_enum module
------------------------------------------
.. automodule:: cpl.console.background_color_enum
:members:
:undoc-members:
:show-inheritance:
cpl.console.console module
--------------------------
.. automodule:: cpl.console.console
:members:
:undoc-members:
:show-inheritance:
cpl.console.console\_call module
--------------------------------
.. automodule:: cpl.console.console_call
:members:
:undoc-members:
:show-inheritance:
cpl.console.foreground\_color\_enum module
------------------------------------------
.. automodule:: cpl.console.foreground_color_enum
:members:
:undoc-members:
:show-inheritance:
cpl.console.spinner\_thread module
----------------------------------
.. automodule:: cpl.console.spinner_thread
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,18 @@
cpl.database.connection
===============================
cpl.database.connection.database\_connection module
---------------------------------------------------
.. automodule:: cpl.database.connection.database_connection
:members:
:undoc-members:
:show-inheritance:
cpl.database.connection.database\_connection\_abc module
--------------------------------------------------------
.. automodule:: cpl.database.connection.database_connection_abc
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,18 @@
cpl.database.context
============================
cpl.database.context.database\_context module
---------------------------------------------
.. automodule:: cpl.database.context.database_context
:members:
:undoc-members:
:show-inheritance:
cpl.database.context.database\_context\_abc module
--------------------------------------------------
.. automodule:: cpl.database.context.database_context_abc
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,35 @@
cpl.database
====================
.. toctree::
:maxdepth: 4
cpl.database.connection
cpl.database.context
Submodules
----------
cpl.database.database\_model module
-----------------------------------
.. automodule:: cpl.database.database_model
:members:
:undoc-members:
:show-inheritance:
cpl.database.database\_settings module
--------------------------------------
.. automodule:: cpl.database.database_settings
:members:
:undoc-members:
:show-inheritance:
cpl.database.database\_settings\_name\_enum module
--------------------------------------------------
.. automodule:: cpl.database.database_settings_name_enum
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,50 @@
cpl.dependency\_injection
=================================
cpl.dependency\_injection.service\_collection module
----------------------------------------------------
.. automodule:: cpl.dependency_injection.service_collection
:members:
:undoc-members:
:show-inheritance:
cpl.dependency\_injection.service\_collection\_abc module
---------------------------------------------------------
.. automodule:: cpl.dependency_injection.service_collection_abc
:members:
:undoc-members:
:show-inheritance:
cpl.dependency\_injection.service\_descriptor module
----------------------------------------------------
.. automodule:: cpl.dependency_injection.service_descriptor
:members:
:undoc-members:
:show-inheritance:
cpl.dependency\_injection.service\_lifetime\_enum module
--------------------------------------------------------
.. automodule:: cpl.dependency_injection.service_lifetime_enum
:members:
:undoc-members:
:show-inheritance:
cpl.dependency\_injection.service\_provider module
--------------------------------------------------
.. automodule:: cpl.dependency_injection.service_provider
:members:
:undoc-members:
:show-inheritance:
cpl.dependency\_injection.service\_provider\_abc module
-------------------------------------------------------
.. automodule:: cpl.dependency_injection.service_provider_abc
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,26 @@
cpl.environment
=======================
cpl.environment.application\_environment module
-----------------------------------------------
.. automodule:: cpl.environment.application_environment
:members:
:undoc-members:
:show-inheritance:
cpl.environment.application\_environment\_abc module
----------------------------------------------------
.. automodule:: cpl.environment.application_environment_abc
:members:
:undoc-members:
:show-inheritance:
cpl.environment.environment\_name\_enum module
----------------------------------------------
.. automodule:: cpl.environment.environment_name_enum
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,42 @@
cpl.logging
===================
cpl.logging.logger\_abc module
------------------------------
.. automodule:: cpl.logging.logger_abc
:members:
:undoc-members:
:show-inheritance:
cpl.logging.logger\_service module
----------------------------------
.. automodule:: cpl.logging.logger_service
:members:
:undoc-members:
:show-inheritance:
cpl.logging.logging\_level\_enum module
---------------------------------------
.. automodule:: cpl.logging.logging_level_enum
:members:
:undoc-members:
:show-inheritance:
cpl.logging.logging\_settings module
------------------------------------
.. automodule:: cpl.logging.logging_settings
:members:
:undoc-members:
:show-inheritance:
cpl.logging.logging\_settings\_name\_enum module
------------------------------------------------
.. automodule:: cpl.logging.logging_settings_name_enum
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,42 @@
cpl.mailing
===================
cpl.mailing.email module
------------------------
.. automodule:: cpl.mailing.email
:members:
:undoc-members:
:show-inheritance:
cpl.mailing.email\_client\_abc module
-------------------------------------
.. automodule:: cpl.mailing.email_client_abc
:members:
:undoc-members:
:show-inheritance:
cpl.mailing.email\_client\_service module
-----------------------------------------
.. automodule:: cpl.mailing.email_client_service
:members:
:undoc-members:
:show-inheritance:
cpl.mailing.email\_client\_settings module
------------------------------------------
.. automodule:: cpl.mailing.email_client_settings
:members:
:undoc-members:
:show-inheritance:
cpl.mailing.email\_client\_settings\_name\_enum module
------------------------------------------------------
.. automodule:: cpl.mailing.email_client_settings_name_enum
:members:
:undoc-members:
:show-inheritance:

24
docs/build/html/_sources/cpl.rst.txt vendored Normal file
View File

@@ -0,0 +1,24 @@
CPL
===========
.. toctree::
:maxdepth: 4
cpl.application
cpl.configuration
cpl.console
cpl.database
cpl.dependency_injection
cpl.environment
cpl.logging
cpl.mailing
cpl.time
cpl.utils
Module contents
---------------
.. automodule:: cpl
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,18 @@
cpl.time
================
cpl.time.time\_format\_settings module
--------------------------------------
.. automodule:: cpl.time.time_format_settings
:members:
:undoc-members:
:show-inheritance:
cpl.time.time\_format\_settings\_names\_enum module
---------------------------------------------------
.. automodule:: cpl.time.time_format_settings_names_enum
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,26 @@
cpl.utils
=================
cpl.utils.credential\_manager module
------------------------------------
.. automodule:: cpl.utils.credential_manager
:members:
:undoc-members:
:show-inheritance:
cpl.utils.pip module
--------------------
.. automodule:: cpl.utils.pip
:members:
:undoc-members:
:show-inheritance:
cpl.utils.string module
-----------------------
.. automodule:: cpl.utils.string
:members:
:undoc-members:
:show-inheritance:

22
docs/build/html/_sources/index.rst.txt vendored Normal file
View File

@@ -0,0 +1,22 @@
.. Common Python Library documentation master file, created by
sphinx-quickstart on Wed Apr 14 10:25:36 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Introduction to the CPL Docs
===========================
The Common Python Library (CPL) is a package for python and a development platform meant to help you create simple and efficient server and desktop applications.
This CPL docs help you learn, understand and use the package. From your first application to complex apps for enterprises.
Manuals
---------
These pages go into great detail about everything the Library can do.
.. toctree::
:maxdepth: 1
cpl
cpl_cli

View File

@@ -0,0 +1,7 @@
cpl
===
.. toctree::
:maxdepth: 4
cpl