Added cpl_cli docs & moved cpl_cli/templates -> cpl_cli/_templates

docs/source/conf.py

@@ -15,7 +15,7 @@
 # sys.path.insert(0, os.path.abspath('.'))
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../../src/cpl'))
+sys.path.insert(0, os.path.abspath('../../src'))
 
 
 # -- Project information -----------------------------------------------------
@@ -41,7 +41,10 @@ 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 = []
+exclude_patterns = [
+    'cpl_cli/templates/*',
+    'tests/*'
+]
 
 
 # -- Options for HTML output -------------------------------------------------

docs/source/cpl_cli.command.rst

@@ -0,0 +1,98 @@
+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:

docs/source/cpl_cli.configuration.rst

@@ -0,0 +1,82 @@
+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:

docs/source/cpl_cli.live_server.rst

@@ -0,0 +1,18 @@
+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:

docs/source/cpl_cli.publish.rst

@@ -0,0 +1,18 @@
+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:

docs/source/cpl_cli.rst

@@ -0,0 +1,92 @@
+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:

docs/source/cpl_cli.source_creator.rst

@@ -0,0 +1,26 @@
+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:

docs/source/modules.rst

@@ -2,6 +2,7 @@ cpl
 ===
 
 .. toctree::
-   :maxdepth: 4
+    :maxdepth: 4
 
-   cpl
+    cpl
+    cpl_cli