From fe36794d81852de8b7800b465aec9e20208ea816 Mon Sep 17 00:00:00 2001 From: Stefano Borini <sborini@enthought.com> Date: Fri, 28 Jul 2017 11:31:58 +0100 Subject: [PATCH] Updated documentation --- doc/source/api/force_bdss.cli.rst | 8 ++-- doc/source/api/force_bdss.cli.tests.rst | 8 ++-- ..._bdss.core_plugins.dummy.csv_extractor.rst | 23 ++++++---- ...core_plugins.dummy.csv_extractor.tests.rst | 30 +++++++++++++ ...e_bdss.core_plugins.dummy.dummy_dakota.rst | 27 ++++++----- ....core_plugins.dummy.dummy_dakota.tests.rst | 30 +++++++++++++ ...s.core_plugins.dummy.dummy_data_source.rst | 45 +++++++++++++++++++ ..._plugins.dummy.dummy_data_source.tests.rst | 30 +++++++++++++ ...ore_plugins.dummy.dummy_kpi_calculator.rst | 23 ++++++---- ...ugins.dummy.dummy_kpi_calculator.tests.rst | 22 +++++++++ ...orce_bdss.core_plugins.dummy.kpi_adder.rst | 23 ++++++---- ...dss.core_plugins.dummy.kpi_adder.tests.rst | 22 +++++++++ .../api/force_bdss.core_plugins.dummy.rst | 10 +++-- .../force_bdss.core_plugins.dummy.tests.rst | 30 +++++++++++++ doc/source/api/force_bdss.core_plugins.rst | 4 +- doc/source/api/force_bdss.data_sources.rst | 28 ++++++------ .../api/force_bdss.data_sources.tests.rst | 12 ++--- doc/source/api/force_bdss.io.rst | 12 ++--- doc/source/api/force_bdss.io.tests.rst | 12 ++--- doc/source/api/force_bdss.kpi.rst | 24 +++++----- doc/source/api/force_bdss.kpi.tests.rst | 12 ++--- doc/source/api/force_bdss.mco.parameters.rst | 20 ++++----- .../api/force_bdss.mco.parameters.tests.rst | 20 ++++----- doc/source/api/force_bdss.mco.rst | 34 +++++++------- doc/source/api/force_bdss.mco.tests.rst | 22 ++++----- doc/source/api/force_bdss.rst | 36 +++++++-------- doc/source/api/force_bdss.tests.fixtures.rst | 4 +- doc/source/api/force_bdss.tests.rst | 28 +++++++++--- doc/source/api/force_bdss.workspecs.rst | 8 ++-- 29 files changed, 431 insertions(+), 176 deletions(-) create mode 100644 doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.tests.rst create mode 100644 doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.tests.rst create mode 100644 doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.rst create mode 100644 doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.tests.rst create mode 100644 doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.rst create mode 100644 doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.tests.rst create mode 100644 doc/source/api/force_bdss.core_plugins.dummy.tests.rst diff --git a/doc/source/api/force_bdss.cli.rst b/doc/source/api/force_bdss.cli.rst index c96292e..c6f155f 100644 --- a/doc/source/api/force_bdss.cli.rst +++ b/doc/source/api/force_bdss.cli.rst @@ -1,5 +1,5 @@ -force_bdss.cli package -====================== +force\_bdss\.cli package +======================== Subpackages ----------- @@ -11,8 +11,8 @@ Subpackages Submodules ---------- -force_bdss.cli.force_bdss module --------------------------------- +force\_bdss\.cli\.force\_bdss module +------------------------------------ .. automodule:: force_bdss.cli.force_bdss :members: diff --git a/doc/source/api/force_bdss.cli.tests.rst b/doc/source/api/force_bdss.cli.tests.rst index 5fef4d6..207d951 100644 --- a/doc/source/api/force_bdss.cli.tests.rst +++ b/doc/source/api/force_bdss.cli.tests.rst @@ -1,11 +1,11 @@ -force_bdss.cli.tests package -============================ +force\_bdss\.cli\.tests package +=============================== Submodules ---------- -force_bdss.cli.tests.test_execution module ------------------------------------------- +force\_bdss\.cli\.tests\.test\_execution module +----------------------------------------------- .. automodule:: force_bdss.cli.tests.test_execution :members: diff --git a/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.rst b/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.rst index 7ec4b2b..9ae5985 100644 --- a/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.rst +++ b/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.rst @@ -1,27 +1,34 @@ -force_bdss.core_plugins.dummy.csv_extractor package -=================================================== +force\_bdss\.core\_plugins\.dummy\.csv\_extractor package +========================================================= + +Subpackages +----------- + +.. toctree:: + + force_bdss.core_plugins.dummy.csv_extractor.tests Submodules ---------- -force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_bundle module ------------------------------------------------------------------------ +force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.csv\_extractor\_bundle module +-------------------------------------------------------------------------------- .. automodule:: force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_bundle :members: :undoc-members: :show-inheritance: -force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_data_source module ----------------------------------------------------------------------------- +force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.csv\_extractor\_data\_source module +-------------------------------------------------------------------------------------- .. automodule:: force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_data_source :members: :undoc-members: :show-inheritance: -force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_model module ----------------------------------------------------------------------- +force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.csv\_extractor\_model module +------------------------------------------------------------------------------- .. automodule:: force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_model :members: diff --git a/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.tests.rst new file mode 100644 index 0000000..95ab6ce --- /dev/null +++ b/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.tests.rst @@ -0,0 +1,30 @@ +force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.tests package +================================================================ + +Submodules +---------- + +force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.tests\.test\_csv\_extractor\_bundle module +--------------------------------------------------------------------------------------------- + +.. automodule:: force_bdss.core_plugins.dummy.csv_extractor.tests.test_csv_extractor_bundle + :members: + :undoc-members: + :show-inheritance: + +force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.tests\.test\_csv\_extractor\_data\_source module +--------------------------------------------------------------------------------------------------- + +.. automodule:: force_bdss.core_plugins.dummy.csv_extractor.tests.test_csv_extractor_data_source + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: force_bdss.core_plugins.dummy.csv_extractor.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.rst index 2745070..9ddaee4 100644 --- a/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.rst +++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.rst @@ -1,35 +1,42 @@ -force_bdss.core_plugins.dummy.dummy_dakota package -================================================== +force\_bdss\.core\_plugins\.dummy\.dummy\_dakota package +======================================================== + +Subpackages +----------- + +.. toctree:: + + force_bdss.core_plugins.dummy.dummy_dakota.tests Submodules ---------- -force_bdss.core_plugins.dummy.dummy_dakota.dakota_bundle module ---------------------------------------------------------------- +force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.dakota\_bundle module +----------------------------------------------------------------------- .. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.dakota_bundle :members: :undoc-members: :show-inheritance: -force_bdss.core_plugins.dummy.dummy_dakota.dakota_communicator module ---------------------------------------------------------------------- +force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.dakota\_communicator module +----------------------------------------------------------------------------- .. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.dakota_communicator :members: :undoc-members: :show-inheritance: -force_bdss.core_plugins.dummy.dummy_dakota.dakota_model module --------------------------------------------------------------- +force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.dakota\_model module +---------------------------------------------------------------------- .. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.dakota_model :members: :undoc-members: :show-inheritance: -force_bdss.core_plugins.dummy.dummy_dakota.dakota_optimizer module ------------------------------------------------------------------- +force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.dakota\_optimizer module +-------------------------------------------------------------------------- .. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.dakota_optimizer :members: diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.tests.rst new file mode 100644 index 0000000..0e5975a --- /dev/null +++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.tests.rst @@ -0,0 +1,30 @@ +force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.tests package +=============================================================== + +Submodules +---------- + +force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.tests\.test\_dakota\_bundle module +------------------------------------------------------------------------------------ + +.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.tests.test_dakota_bundle + :members: + :undoc-members: + :show-inheritance: + +force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.tests\.test\_dakota\_communicator module +------------------------------------------------------------------------------------------ + +.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.tests.test_dakota_communicator + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.rst new file mode 100644 index 0000000..da0f4ed --- /dev/null +++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.rst @@ -0,0 +1,45 @@ +force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source package +============================================================== + +Subpackages +----------- + +.. toctree:: + + force_bdss.core_plugins.dummy.dummy_data_source.tests + +Submodules +---------- + +force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source\.dummy\_data\_source module +---------------------------------------------------------------------------------- + +.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.dummy_data_source + :members: + :undoc-members: + :show-inheritance: + +force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source\.dummy\_data\_source\_bundle module +------------------------------------------------------------------------------------------ + +.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.dummy_data_source_bundle + :members: + :undoc-members: + :show-inheritance: + +force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source\.dummy\_data\_source\_model module +----------------------------------------------------------------------------------------- + +.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.dummy_data_source_model + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.tests.rst new file mode 100644 index 0000000..a665a03 --- /dev/null +++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.tests.rst @@ -0,0 +1,30 @@ +force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source\.tests package +===================================================================== + +Submodules +---------- + +force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source\.tests\.test\_dummy\_data\_source module +----------------------------------------------------------------------------------------------- + +.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.tests.test_dummy_data_source + :members: + :undoc-members: + :show-inheritance: + +force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source\.tests\.test\_dummy\_data\_source\_bundle module +------------------------------------------------------------------------------------------------------- + +.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.tests.test_dummy_data_source_bundle + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.rst index 4dde56d..5de1ecc 100644 --- a/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.rst +++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.rst @@ -1,27 +1,34 @@ -force_bdss.core_plugins.dummy.dummy_kpi_calculator package -========================================================== +force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator package +================================================================= + +Subpackages +----------- + +.. toctree:: + + force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests Submodules ---------- -force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator module ------------------------------------------------------------------------------- +force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.dummy\_kpi\_calculator module +---------------------------------------------------------------------------------------- .. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator :members: :undoc-members: :show-inheritance: -force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator_bundle module -------------------------------------------------------------------------------------- +force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.dummy\_kpi\_calculator\_bundle module +------------------------------------------------------------------------------------------------ .. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator_bundle :members: :undoc-members: :show-inheritance: -force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator_model module ------------------------------------------------------------------------------------- +force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.dummy\_kpi\_calculator\_model module +----------------------------------------------------------------------------------------------- .. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator_model :members: diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.rst new file mode 100644 index 0000000..bf54bf5 --- /dev/null +++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.rst @@ -0,0 +1,22 @@ +force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.tests package +======================================================================== + +Submodules +---------- + +force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.tests\.test\_dummy\_kpi\_calculator\_bundle module +------------------------------------------------------------------------------------------------------------- + +.. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.test_dummy_kpi_calculator_bundle + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.rst b/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.rst index 58c3acc..ea4c2ba 100644 --- a/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.rst +++ b/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.rst @@ -1,27 +1,34 @@ -force_bdss.core_plugins.dummy.kpi_adder package -=============================================== +force\_bdss\.core\_plugins\.dummy\.kpi\_adder package +===================================================== + +Subpackages +----------- + +.. toctree:: + + force_bdss.core_plugins.dummy.kpi_adder.tests Submodules ---------- -force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_bundle module ---------------------------------------------------------------- +force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.kpi\_adder\_bundle module +------------------------------------------------------------------------ .. automodule:: force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_bundle :members: :undoc-members: :show-inheritance: -force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_calculator module -------------------------------------------------------------------- +force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.kpi\_adder\_calculator module +---------------------------------------------------------------------------- .. automodule:: force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_calculator :members: :undoc-members: :show-inheritance: -force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_model module --------------------------------------------------------------- +force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.kpi\_adder\_model module +----------------------------------------------------------------------- .. automodule:: force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_model :members: diff --git a/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.tests.rst new file mode 100644 index 0000000..3937a7e --- /dev/null +++ b/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.tests.rst @@ -0,0 +1,22 @@ +force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.tests package +============================================================ + +Submodules +---------- + +force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.tests\.test\_kpi\_adder\_bundle module +------------------------------------------------------------------------------------- + +.. automodule:: force_bdss.core_plugins.dummy.kpi_adder.tests.test_kpi_adder_bundle + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: force_bdss.core_plugins.dummy.kpi_adder.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/force_bdss.core_plugins.dummy.rst b/doc/source/api/force_bdss.core_plugins.dummy.rst index 9855728..82b8d02 100644 --- a/doc/source/api/force_bdss.core_plugins.dummy.rst +++ b/doc/source/api/force_bdss.core_plugins.dummy.rst @@ -1,5 +1,5 @@ -force_bdss.core_plugins.dummy package -===================================== +force\_bdss\.core\_plugins\.dummy package +========================================= Subpackages ----------- @@ -8,14 +8,16 @@ Subpackages force_bdss.core_plugins.dummy.csv_extractor force_bdss.core_plugins.dummy.dummy_dakota + force_bdss.core_plugins.dummy.dummy_data_source force_bdss.core_plugins.dummy.dummy_kpi_calculator force_bdss.core_plugins.dummy.kpi_adder + force_bdss.core_plugins.dummy.tests Submodules ---------- -force_bdss.core_plugins.dummy.dummy_plugin module -------------------------------------------------- +force\_bdss\.core\_plugins\.dummy\.dummy\_plugin module +------------------------------------------------------- .. automodule:: force_bdss.core_plugins.dummy.dummy_plugin :members: diff --git a/doc/source/api/force_bdss.core_plugins.dummy.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.tests.rst new file mode 100644 index 0000000..fbe318a --- /dev/null +++ b/doc/source/api/force_bdss.core_plugins.dummy.tests.rst @@ -0,0 +1,30 @@ +force\_bdss\.core\_plugins\.dummy\.tests package +================================================ + +Submodules +---------- + +force\_bdss\.core\_plugins\.dummy\.tests\.data\_source\_bundle\_test\_mixin module +---------------------------------------------------------------------------------- + +.. automodule:: force_bdss.core_plugins.dummy.tests.data_source_bundle_test_mixin + :members: + :undoc-members: + :show-inheritance: + +force\_bdss\.core\_plugins\.dummy\.tests\.kpi\_calculator\_bundle\_test\_mixin module +------------------------------------------------------------------------------------- + +.. automodule:: force_bdss.core_plugins.dummy.tests.kpi_calculator_bundle_test_mixin + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: force_bdss.core_plugins.dummy.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/force_bdss.core_plugins.rst b/doc/source/api/force_bdss.core_plugins.rst index aabfada..d667de4 100644 --- a/doc/source/api/force_bdss.core_plugins.rst +++ b/doc/source/api/force_bdss.core_plugins.rst @@ -1,5 +1,5 @@ -force_bdss.core_plugins package -=============================== +force\_bdss\.core\_plugins package +================================== Subpackages ----------- diff --git a/doc/source/api/force_bdss.data_sources.rst b/doc/source/api/force_bdss.data_sources.rst index 7df2d7d..e554809 100644 --- a/doc/source/api/force_bdss.data_sources.rst +++ b/doc/source/api/force_bdss.data_sources.rst @@ -1,5 +1,5 @@ -force_bdss.data_sources package -=============================== +force\_bdss\.data\_sources package +================================== Subpackages ----------- @@ -11,48 +11,48 @@ Subpackages Submodules ---------- -force_bdss.data_sources.base_data_source module ------------------------------------------------ +force\_bdss\.data\_sources\.base\_data\_source module +----------------------------------------------------- .. automodule:: force_bdss.data_sources.base_data_source :members: :undoc-members: :show-inheritance: -force_bdss.data_sources.base_data_source_bundle module ------------------------------------------------------- +force\_bdss\.data\_sources\.base\_data\_source\_bundle module +------------------------------------------------------------- .. automodule:: force_bdss.data_sources.base_data_source_bundle :members: :undoc-members: :show-inheritance: -force_bdss.data_sources.base_data_source_model module ------------------------------------------------------ +force\_bdss\.data\_sources\.base\_data\_source\_model module +------------------------------------------------------------ .. automodule:: force_bdss.data_sources.base_data_source_model :members: :undoc-members: :show-inheritance: -force_bdss.data_sources.data_source_parameters module ------------------------------------------------------ +force\_bdss\.data\_sources\.data\_source\_parameters module +----------------------------------------------------------- .. automodule:: force_bdss.data_sources.data_source_parameters :members: :undoc-members: :show-inheritance: -force_bdss.data_sources.data_source_result module -------------------------------------------------- +force\_bdss\.data\_sources\.data\_source\_result module +------------------------------------------------------- .. automodule:: force_bdss.data_sources.data_source_result :members: :undoc-members: :show-inheritance: -force_bdss.data_sources.i_data_source_bundle module ---------------------------------------------------- +force\_bdss\.data\_sources\.i\_data\_source\_bundle module +---------------------------------------------------------- .. automodule:: force_bdss.data_sources.i_data_source_bundle :members: diff --git a/doc/source/api/force_bdss.data_sources.tests.rst b/doc/source/api/force_bdss.data_sources.tests.rst index 067997c..2b9563c 100644 --- a/doc/source/api/force_bdss.data_sources.tests.rst +++ b/doc/source/api/force_bdss.data_sources.tests.rst @@ -1,19 +1,19 @@ -force_bdss.data_sources.tests package -===================================== +force\_bdss\.data\_sources\.tests package +========================================= Submodules ---------- -force_bdss.data_sources.tests.test_base_data_source module ----------------------------------------------------------- +force\_bdss\.data\_sources\.tests\.test\_base\_data\_source module +------------------------------------------------------------------ .. automodule:: force_bdss.data_sources.tests.test_base_data_source :members: :undoc-members: :show-inheritance: -force_bdss.data_sources.tests.test_base_data_source_bundle module ------------------------------------------------------------------ +force\_bdss\.data\_sources\.tests\.test\_base\_data\_source\_bundle module +-------------------------------------------------------------------------- .. automodule:: force_bdss.data_sources.tests.test_base_data_source_bundle :members: diff --git a/doc/source/api/force_bdss.io.rst b/doc/source/api/force_bdss.io.rst index c221828..558ecbe 100644 --- a/doc/source/api/force_bdss.io.rst +++ b/doc/source/api/force_bdss.io.rst @@ -1,5 +1,5 @@ -force_bdss.io package -===================== +force\_bdss\.io package +======================= Subpackages ----------- @@ -11,16 +11,16 @@ Subpackages Submodules ---------- -force_bdss.io.workflow_reader module ------------------------------------- +force\_bdss\.io\.workflow\_reader module +---------------------------------------- .. automodule:: force_bdss.io.workflow_reader :members: :undoc-members: :show-inheritance: -force_bdss.io.workflow_writer module ------------------------------------- +force\_bdss\.io\.workflow\_writer module +---------------------------------------- .. automodule:: force_bdss.io.workflow_writer :members: diff --git a/doc/source/api/force_bdss.io.tests.rst b/doc/source/api/force_bdss.io.tests.rst index d7512c8..7a53cce 100644 --- a/doc/source/api/force_bdss.io.tests.rst +++ b/doc/source/api/force_bdss.io.tests.rst @@ -1,19 +1,19 @@ -force_bdss.io.tests package -=========================== +force\_bdss\.io\.tests package +============================== Submodules ---------- -force_bdss.io.tests.test_workflow_reader module ------------------------------------------------ +force\_bdss\.io\.tests\.test\_workflow\_reader module +----------------------------------------------------- .. automodule:: force_bdss.io.tests.test_workflow_reader :members: :undoc-members: :show-inheritance: -force_bdss.io.tests.test_workflow_writer module ------------------------------------------------ +force\_bdss\.io\.tests\.test\_workflow\_writer module +----------------------------------------------------- .. automodule:: force_bdss.io.tests.test_workflow_writer :members: diff --git a/doc/source/api/force_bdss.kpi.rst b/doc/source/api/force_bdss.kpi.rst index b90b1b5..c8c9a36 100644 --- a/doc/source/api/force_bdss.kpi.rst +++ b/doc/source/api/force_bdss.kpi.rst @@ -1,5 +1,5 @@ -force_bdss.kpi package -====================== +force\_bdss\.kpi package +======================== Subpackages ----------- @@ -11,40 +11,40 @@ Subpackages Submodules ---------- -force_bdss.kpi.base_kpi_calculator module ------------------------------------------ +force\_bdss\.kpi\.base\_kpi\_calculator module +---------------------------------------------- .. automodule:: force_bdss.kpi.base_kpi_calculator :members: :undoc-members: :show-inheritance: -force_bdss.kpi.base_kpi_calculator_bundle module ------------------------------------------------- +force\_bdss\.kpi\.base\_kpi\_calculator\_bundle module +------------------------------------------------------ .. automodule:: force_bdss.kpi.base_kpi_calculator_bundle :members: :undoc-members: :show-inheritance: -force_bdss.kpi.base_kpi_calculator_model module ------------------------------------------------ +force\_bdss\.kpi\.base\_kpi\_calculator\_model module +----------------------------------------------------- .. automodule:: force_bdss.kpi.base_kpi_calculator_model :members: :undoc-members: :show-inheritance: -force_bdss.kpi.i_kpi_calculator_bundle module ---------------------------------------------- +force\_bdss\.kpi\.i\_kpi\_calculator\_bundle module +--------------------------------------------------- .. automodule:: force_bdss.kpi.i_kpi_calculator_bundle :members: :undoc-members: :show-inheritance: -force_bdss.kpi.kpi_calculator_result module -------------------------------------------- +force\_bdss\.kpi\.kpi\_calculator\_result module +------------------------------------------------ .. automodule:: force_bdss.kpi.kpi_calculator_result :members: diff --git a/doc/source/api/force_bdss.kpi.tests.rst b/doc/source/api/force_bdss.kpi.tests.rst index 9c7eb6c..e7a8126 100644 --- a/doc/source/api/force_bdss.kpi.tests.rst +++ b/doc/source/api/force_bdss.kpi.tests.rst @@ -1,19 +1,19 @@ -force_bdss.kpi.tests package -============================ +force\_bdss\.kpi\.tests package +=============================== Submodules ---------- -force_bdss.kpi.tests.test_base_kpi_calculator module ----------------------------------------------------- +force\_bdss\.kpi\.tests\.test\_base\_kpi\_calculator module +----------------------------------------------------------- .. automodule:: force_bdss.kpi.tests.test_base_kpi_calculator :members: :undoc-members: :show-inheritance: -force_bdss.kpi.tests.test_base_kpi_calculator_bundle module ------------------------------------------------------------ +force\_bdss\.kpi\.tests\.test\_base\_kpi\_calculator\_bundle module +------------------------------------------------------------------- .. automodule:: force_bdss.kpi.tests.test_base_kpi_calculator_bundle :members: diff --git a/doc/source/api/force_bdss.mco.parameters.rst b/doc/source/api/force_bdss.mco.parameters.rst index f289f43..8bad9d2 100644 --- a/doc/source/api/force_bdss.mco.parameters.rst +++ b/doc/source/api/force_bdss.mco.parameters.rst @@ -1,5 +1,5 @@ -force_bdss.mco.parameters package -================================= +force\_bdss\.mco\.parameters package +==================================== Subpackages ----------- @@ -11,32 +11,32 @@ Subpackages Submodules ---------- -force_bdss.mco.parameters.base_mco_parameter module ---------------------------------------------------- +force\_bdss\.mco\.parameters\.base\_mco\_parameter module +--------------------------------------------------------- .. automodule:: force_bdss.mco.parameters.base_mco_parameter :members: :undoc-members: :show-inheritance: -force_bdss.mco.parameters.base_mco_parameter_factory module ------------------------------------------------------------ +force\_bdss\.mco\.parameters\.base\_mco\_parameter\_factory module +------------------------------------------------------------------ .. automodule:: force_bdss.mco.parameters.base_mco_parameter_factory :members: :undoc-members: :show-inheritance: -force_bdss.mco.parameters.core_mco_parameters module ----------------------------------------------------- +force\_bdss\.mco\.parameters\.core\_mco\_parameters module +---------------------------------------------------------- .. automodule:: force_bdss.mco.parameters.core_mco_parameters :members: :undoc-members: :show-inheritance: -force_bdss.mco.parameters.mco_parameter_factory_registry module ---------------------------------------------------------------- +force\_bdss\.mco\.parameters\.mco\_parameter\_factory\_registry module +---------------------------------------------------------------------- .. automodule:: force_bdss.mco.parameters.mco_parameter_factory_registry :members: diff --git a/doc/source/api/force_bdss.mco.parameters.tests.rst b/doc/source/api/force_bdss.mco.parameters.tests.rst index 694cb15..c8950c2 100644 --- a/doc/source/api/force_bdss.mco.parameters.tests.rst +++ b/doc/source/api/force_bdss.mco.parameters.tests.rst @@ -1,35 +1,35 @@ -force_bdss.mco.parameters.tests package -======================================= +force\_bdss\.mco\.parameters\.tests package +=========================================== Submodules ---------- -force_bdss.mco.parameters.tests.test_base_mco_parameter module --------------------------------------------------------------- +force\_bdss\.mco\.parameters\.tests\.test\_base\_mco\_parameter module +---------------------------------------------------------------------- .. automodule:: force_bdss.mco.parameters.tests.test_base_mco_parameter :members: :undoc-members: :show-inheritance: -force_bdss.mco.parameters.tests.test_base_mco_parameter_factory module ----------------------------------------------------------------------- +force\_bdss\.mco\.parameters\.tests\.test\_base\_mco\_parameter\_factory module +------------------------------------------------------------------------------- .. automodule:: force_bdss.mco.parameters.tests.test_base_mco_parameter_factory :members: :undoc-members: :show-inheritance: -force_bdss.mco.parameters.tests.test_core_mco_parameters module ---------------------------------------------------------------- +force\_bdss\.mco\.parameters\.tests\.test\_core\_mco\_parameters module +----------------------------------------------------------------------- .. automodule:: force_bdss.mco.parameters.tests.test_core_mco_parameters :members: :undoc-members: :show-inheritance: -force_bdss.mco.parameters.tests.test_parameter_factory_registry module ----------------------------------------------------------------------- +force\_bdss\.mco\.parameters\.tests\.test\_parameter\_factory\_registry module +------------------------------------------------------------------------------ .. automodule:: force_bdss.mco.parameters.tests.test_parameter_factory_registry :members: diff --git a/doc/source/api/force_bdss.mco.rst b/doc/source/api/force_bdss.mco.rst index 8b2a6e3..ced0270 100644 --- a/doc/source/api/force_bdss.mco.rst +++ b/doc/source/api/force_bdss.mco.rst @@ -1,5 +1,5 @@ -force_bdss.mco package -====================== +force\_bdss\.mco package +======================== Subpackages ----------- @@ -12,42 +12,42 @@ Subpackages Submodules ---------- -force_bdss.mco.base_mco_communicator module -------------------------------------------- +force\_bdss\.mco\.base\_mco module +---------------------------------- -.. automodule:: force_bdss.mco.base_mco_communicator +.. automodule:: force_bdss.mco.base_mco :members: :undoc-members: :show-inheritance: -force_bdss.mco.base_mco_model module ------------------------------------- +force\_bdss\.mco\.base\_mco\_bundle module +------------------------------------------ -.. automodule:: force_bdss.mco.base_mco_model +.. automodule:: force_bdss.mco.base_mco_bundle :members: :undoc-members: :show-inheritance: -force_bdss.mco.base_multi_criteria_optimizer module ---------------------------------------------------- +force\_bdss\.mco\.base\_mco\_communicator module +------------------------------------------------ -.. automodule:: force_bdss.mco.base_multi_criteria_optimizer +.. automodule:: force_bdss.mco.base_mco_communicator :members: :undoc-members: :show-inheritance: -force_bdss.mco.base_multi_criteria_optimizer_bundle module ----------------------------------------------------------- +force\_bdss\.mco\.base\_mco\_model module +----------------------------------------- -.. automodule:: force_bdss.mco.base_multi_criteria_optimizer_bundle +.. automodule:: force_bdss.mco.base_mco_model :members: :undoc-members: :show-inheritance: -force_bdss.mco.i_multi_criteria_optimizer_bundle module -------------------------------------------------------- +force\_bdss\.mco\.i\_mco\_bundle module +--------------------------------------- -.. automodule:: force_bdss.mco.i_multi_criteria_optimizer_bundle +.. automodule:: force_bdss.mco.i_mco_bundle :members: :undoc-members: :show-inheritance: diff --git a/doc/source/api/force_bdss.mco.tests.rst b/doc/source/api/force_bdss.mco.tests.rst index 9eb3cab..809ef69 100644 --- a/doc/source/api/force_bdss.mco.tests.rst +++ b/doc/source/api/force_bdss.mco.tests.rst @@ -1,29 +1,29 @@ -force_bdss.mco.tests package -============================ +force\_bdss\.mco\.tests package +=============================== Submodules ---------- -force_bdss.mco.tests.test_base_mco_communicator module ------------------------------------------------------- +force\_bdss\.mco\.tests\.test\_base\_mco module +----------------------------------------------- -.. automodule:: force_bdss.mco.tests.test_base_mco_communicator +.. automodule:: force_bdss.mco.tests.test_base_mco :members: :undoc-members: :show-inheritance: -force_bdss.mco.tests.test_base_multi_criteria_optimizer module --------------------------------------------------------------- +force\_bdss\.mco\.tests\.test\_base\_mco\_bundle module +------------------------------------------------------- -.. automodule:: force_bdss.mco.tests.test_base_multi_criteria_optimizer +.. automodule:: force_bdss.mco.tests.test_base_mco_bundle :members: :undoc-members: :show-inheritance: -force_bdss.mco.tests.test_base_multi_criteria_optimizer_bundle module ---------------------------------------------------------------------- +force\_bdss\.mco\.tests\.test\_base\_mco\_communicator module +------------------------------------------------------------- -.. automodule:: force_bdss.mco.tests.test_base_multi_criteria_optimizer_bundle +.. automodule:: force_bdss.mco.tests.test_base_mco_communicator :members: :undoc-members: :show-inheritance: diff --git a/doc/source/api/force_bdss.rst b/doc/source/api/force_bdss.rst index 2c20d82..63a788a 100644 --- a/doc/source/api/force_bdss.rst +++ b/doc/source/api/force_bdss.rst @@ -1,5 +1,5 @@ -force_bdss package -================== +force\_bdss package +=================== Subpackages ----------- @@ -18,64 +18,64 @@ Subpackages Submodules ---------- -force_bdss.api module ---------------------- +force\_bdss\.api module +----------------------- .. automodule:: force_bdss.api :members: :undoc-members: :show-inheritance: -force_bdss.base_core_driver module ----------------------------------- +force\_bdss\.base\_core\_driver module +-------------------------------------- .. automodule:: force_bdss.base_core_driver :members: :undoc-members: :show-inheritance: -force_bdss.base_extension_plugin module ---------------------------------------- +force\_bdss\.base\_extension\_plugin module +------------------------------------------- .. automodule:: force_bdss.base_extension_plugin :members: :undoc-members: :show-inheritance: -force_bdss.bdss_application module ----------------------------------- +force\_bdss\.bdss\_application module +------------------------------------- .. automodule:: force_bdss.bdss_application :members: :undoc-members: :show-inheritance: -force_bdss.bundle_registry_plugin module ----------------------------------------- +force\_bdss\.bundle\_registry\_plugin module +-------------------------------------------- .. automodule:: force_bdss.bundle_registry_plugin :members: :undoc-members: :show-inheritance: -force_bdss.core_evaluation_driver module ----------------------------------------- +force\_bdss\.core\_evaluation\_driver module +-------------------------------------------- .. automodule:: force_bdss.core_evaluation_driver :members: :undoc-members: :show-inheritance: -force_bdss.core_mco_driver module ---------------------------------- +force\_bdss\.core\_mco\_driver module +------------------------------------- .. automodule:: force_bdss.core_mco_driver :members: :undoc-members: :show-inheritance: -force_bdss.ids module ---------------------- +force\_bdss\.ids module +----------------------- .. automodule:: force_bdss.ids :members: diff --git a/doc/source/api/force_bdss.tests.fixtures.rst b/doc/source/api/force_bdss.tests.fixtures.rst index 67056f7..3c0c12f 100644 --- a/doc/source/api/force_bdss.tests.fixtures.rst +++ b/doc/source/api/force_bdss.tests.fixtures.rst @@ -1,5 +1,5 @@ -force_bdss.tests.fixtures package -================================= +force\_bdss\.tests\.fixtures package +==================================== Module contents --------------- diff --git a/doc/source/api/force_bdss.tests.rst b/doc/source/api/force_bdss.tests.rst index d78f9d3..4aef3da 100644 --- a/doc/source/api/force_bdss.tests.rst +++ b/doc/source/api/force_bdss.tests.rst @@ -1,5 +1,5 @@ -force_bdss.tests package -======================== +force\_bdss\.tests package +========================== Subpackages ----------- @@ -11,16 +11,32 @@ Subpackages Submodules ---------- -force_bdss.tests.test_bundle_registry_plugin module ---------------------------------------------------- +force\_bdss\.tests\.test\_bdss\_application module +-------------------------------------------------- + +.. automodule:: force_bdss.tests.test_bdss_application + :members: + :undoc-members: + :show-inheritance: + +force\_bdss\.tests\.test\_bundle\_registry\_plugin module +--------------------------------------------------------- .. automodule:: force_bdss.tests.test_bundle_registry_plugin :members: :undoc-members: :show-inheritance: -force_bdss.tests.test_id_generators module ------------------------------------------- +force\_bdss\.tests\.test\_core\_evaluation\_driver module +--------------------------------------------------------- + +.. automodule:: force_bdss.tests.test_core_evaluation_driver + :members: + :undoc-members: + :show-inheritance: + +force\_bdss\.tests\.test\_id\_generators module +----------------------------------------------- .. automodule:: force_bdss.tests.test_id_generators :members: diff --git a/doc/source/api/force_bdss.workspecs.rst b/doc/source/api/force_bdss.workspecs.rst index 13fb1dc..d83f60e 100644 --- a/doc/source/api/force_bdss.workspecs.rst +++ b/doc/source/api/force_bdss.workspecs.rst @@ -1,11 +1,11 @@ -force_bdss.workspecs package -============================ +force\_bdss\.workspecs package +============================== Submodules ---------- -force_bdss.workspecs.workflow module ------------------------------------- +force\_bdss\.workspecs\.workflow module +--------------------------------------- .. automodule:: force_bdss.workspecs.workflow :members: -- GitLab