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

Improved documentation for cpl.application

Browse Source
This commit is contained in:
Sven Heidemann
2021-04-14 22:20:18 +02:00
parent ed1a4eb88c
commit 4209055d62
97 changed files with 429 additions and 4987 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/source/conf.py
View File

@@ -6,7 +6,7 @@
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# If extensions (ors to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
@@ -15,7 +15,7 @@
# 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 -----------------------------------------------------
@@ -27,7 +27,7 @@ author = 'Sven Heidemann'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# Add any Sphinx extension names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
@@ -43,6 +43,7 @@ templates_path = ['_templates']
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
'cpl_cli/templates/*',
'cpl_cli/*',
'tests/*'
]
@@ -51,7 +52,7 @@ exclude_patterns = [
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here,

8
docs/source/cpl.application.rst
View File

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

10
docs/source/cpl.configuration.rst
View File

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

10
docs/source/cpl.console.rst
View File

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

4
docs/source/cpl.database.connection.rst
View File

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

4
docs/source/cpl.database.context.rst
View File

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

6
docs/source/cpl.database.rst
View File

@@ -10,7 +10,7 @@ cpl.database
Submodules
----------
cpl.database.database\_model module
cpl.database.database\_model
-----------------------------------
.. automodule:: cpl.database.database_model
@@ -18,7 +18,7 @@ cpl.database.database\_model module
:undoc-members:
:show-inheritance:
cpl.database.database\_settings module
cpl.database.database\_settings
--------------------------------------
.. automodule:: cpl.database.database_settings
@@ -26,7 +26,7 @@ cpl.database.database\_settings module
:undoc-members:
:show-inheritance:
cpl.database.database\_settings\_name\_enum module
cpl.database.database\_settings\_name\_enum
--------------------------------------------------
.. automodule:: cpl.database.database_settings_name_enum

12
docs/source/cpl.dependency_injection.rst
View File

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

6
docs/source/cpl.environment.rst
View File

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

10
docs/source/cpl.logging.rst
View File

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

10
docs/source/cpl.mailing.rst
View File

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

4
docs/source/cpl.time.rst
View File

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

6
docs/source/cpl.utils.rst
View File

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

98
docs/source/cpl_cli.command.rst
View File

@@ -1,98 +0,0 @@
cpl\_cli.command
========================
cpl\_cli.command.add\_service module
------------------------------------
.. automodule:: cpl_cli.command.add_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.build\_service module
--------------------------------------
.. automodule:: cpl_cli.command.build_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.generate\_service module
-----------------------------------------
.. automodule:: cpl_cli.command.generate_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.help\_service module
-------------------------------------
.. automodule:: cpl_cli.command.help_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.install\_service module
----------------------------------------
.. automodule:: cpl_cli.command.install_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.new\_service module
------------------------------------
.. automodule:: cpl_cli.command.new_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.publish\_service module
----------------------------------------
.. automodule:: cpl_cli.command.publish_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.remove\_service module
---------------------------------------
.. automodule:: cpl_cli.command.remove_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.start\_service module
--------------------------------------
.. automodule:: cpl_cli.command.start_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.uninstall\_service module
------------------------------------------
.. automodule:: cpl_cli.command.uninstall_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.update\_service module
---------------------------------------
.. automodule:: cpl_cli.command.update_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command.version\_service module
----------------------------------------
.. automodule:: cpl_cli.command.version_service
:members:
:undoc-members:
:show-inheritance:

82
docs/source/cpl_cli.configuration.rst
View File

@@ -1,82 +0,0 @@
cpl\_cli.configuration
==============================
cpl\_cli.configuration.build\_settings module
---------------------------------------------
.. automodule:: cpl_cli.configuration.build_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.build\_settings\_name\_enum module
---------------------------------------------------------
.. automodule:: cpl_cli.configuration.build_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.project\_settings module
-----------------------------------------------
.. automodule:: cpl_cli.configuration.project_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.project\_settings\_name\_enum module
-----------------------------------------------------------
.. automodule:: cpl_cli.configuration.project_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.project\_type\_enum module
-------------------------------------------------
.. automodule:: cpl_cli.configuration.project_type_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.settings\_helper module
----------------------------------------------
.. automodule:: cpl_cli.configuration.settings_helper
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.version\_settings module
-----------------------------------------------
.. automodule:: cpl_cli.configuration.version_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.version\_settings\_name\_enum module
-----------------------------------------------------------
.. automodule:: cpl_cli.configuration.version_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.workspace\_settings module
-------------------------------------------------
.. automodule:: cpl_cli.configuration.workspace_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.configuration.workspace\_settings\_name\_enum module
-------------------------------------------------------------
.. automodule:: cpl_cli.configuration.workspace_settings_name_enum
:members:
:undoc-members:
:show-inheritance:

18
docs/source/cpl_cli.live_server.rst
View File

@@ -1,18 +0,0 @@
cpl\_cli.live\_server
=============================
cpl\_cli.live\_server.live\_server\_service module
--------------------------------------------------
.. automodule:: cpl_cli.live_server.live_server_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.live\_server.live\_server\_thread module
-------------------------------------------------
.. automodule:: cpl_cli.live_server.live_server_thread
:members:
:undoc-members:
:show-inheritance:

18
docs/source/cpl_cli.publish.rst
View File

@@ -1,18 +0,0 @@
cpl\_cli.publish
========================
cpl\_cli.publish.publisher\_abc module
--------------------------------------
.. automodule:: cpl_cli.publish.publisher_abc
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.publish.publisher\_service module
------------------------------------------
.. automodule:: cpl_cli.publish.publisher_service
:members:
:undoc-members:
:show-inheritance:

92
docs/source/cpl_cli.rst
View File

@@ -1,92 +0,0 @@
CPL_CLI
================
.. toctree::
:maxdepth: 4
cpl_cli.command
cpl_cli.configuration
cpl_cli.live_server
cpl_cli.publish
cpl_cli.source_creator
cpl_cli.templates
cpl\_cli.cli
-------------------
.. automodule:: cpl_cli.cli
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.cli\_settings
-----------------------------
.. automodule:: cpl_cli.cli_settings
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.cli\_settings\_name\_enum
-----------------------------------------
.. automodule:: cpl_cli.cli_settings_name_enum
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command\_abc
----------------------------
.. automodule:: cpl_cli.command_abc
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command\_handler\_service
-----------------------------------------
.. automodule:: cpl_cli.command_handler_service
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.command\_model
------------------------------
.. automodule:: cpl_cli.command_model
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.error
---------------------
.. automodule:: cpl_cli.error
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.main
--------------------
.. automodule:: cpl_cli.main
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.startup
-----------------------
.. automodule:: cpl_cli.startup
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: cpl_cli
:members:
:undoc-members:
:show-inheritance:

26
docs/source/cpl_cli.source_creator.rst
View File

@@ -1,26 +0,0 @@
cpl\_cli.source\_creator
================================
cpl\_cli.source\_creator.console\_builder module
------------------------------------------------
.. automodule:: cpl_cli.source_creator.console_builder
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.source\_creator.library\_builder module
------------------------------------------------
.. automodule:: cpl_cli.source_creator.library_builder
:members:
:undoc-members:
:show-inheritance:
cpl\_cli.source\_creator.template\_builder module
-------------------------------------------------
.. automodule:: cpl_cli.source_creator.template_builder
:members:
:undoc-members:
:show-inheritance:

1
docs/source/index.rst
View File

@@ -19,4 +19,3 @@ These pages go into great detail about everything the Library can do.
:maxdepth: 1
cpl
cpl_cli

1
docs/source/modules.rst
View File

@@ -5,4 +5,3 @@ cpl
:maxdepth: 4
cpl
cpl_cli