From 8c3681f3b9ea34fd27664153458af1f3176c6b5d Mon Sep 17 00:00:00 2001 From: Stefano Borini <sborini@enthought.com> Date: Thu, 27 Jul 2017 16:58:11 +0100 Subject: [PATCH] Fixed documentation --- ...s.core_plugins.dummy.dummy_data_source.rst | 38 +++++++++++++++++++ .../api/force_bdss.core_plugins.dummy.rst | 1 + doc/source/api/force_bdss.mco.rst | 30 +++++++-------- doc/source/api/force_bdss.mco.tests.rst | 18 ++++----- doc/source/api/force_bdss.tests.rst | 8 ++++ 5 files changed, 71 insertions(+), 24 deletions(-) create mode 100644 doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.rst 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..0d3491b --- /dev/null +++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.rst @@ -0,0 +1,38 @@ +force_bdss.core_plugins.dummy.dummy_data_source package +======================================================= + +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.rst b/doc/source/api/force_bdss.core_plugins.dummy.rst index 9855728..6476239 100644 --- a/doc/source/api/force_bdss.core_plugins.dummy.rst +++ b/doc/source/api/force_bdss.core_plugins.dummy.rst @@ -8,6 +8,7 @@ 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 diff --git a/doc/source/api/force_bdss.mco.rst b/doc/source/api/force_bdss.mco.rst index 8b2a6e3..c8047b3 100644 --- a/doc/source/api/force_bdss.mco.rst +++ b/doc/source/api/force_bdss.mco.rst @@ -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..6dbcf84 100644 --- a/doc/source/api/force_bdss.mco.tests.rst +++ b/doc/source/api/force_bdss.mco.tests.rst @@ -4,26 +4,26 @@ 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.tests.rst b/doc/source/api/force_bdss.tests.rst index d78f9d3..149a14b 100644 --- a/doc/source/api/force_bdss.tests.rst +++ b/doc/source/api/force_bdss.tests.rst @@ -11,6 +11,14 @@ Subpackages Submodules ---------- +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 --------------------------------------------------- -- GitLab