Skip to content
Snippets Groups Projects
Commit fe36794d authored by Stefano Borini's avatar Stefano Borini
Browse files

Updated documentation

parent ea0f1dc1
No related branches found
No related tags found
1 merge request!55Remove application and model from bundles. Added plugin reference.
Hide whitespace changes
Inline Side-by-side
Showing
with 331 additions and 92 deletions
doc/source/api/force_bdss.cli.rst
+ 4
− 4
View file @ fe36794d
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:
......
doc/source/api/force_bdss.cli.tests.rst
+ 4
− 4
View file @ fe36794d
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:
......
doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.rst
+ 15
− 8
View file @ fe36794d
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:
......
doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.tests.rst 0 → 100644
+ 30
− 0
View file @ fe36794d
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:
doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.rst
+ 17
− 10
View file @ fe36794d
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:
......
doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.tests.rst 0 → 100644
+ 30
− 0
View file @ fe36794d
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:
doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.rst 0 → 100644
+ 45
− 0
View file @ fe36794d
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:
doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.tests.rst 0 → 100644
+ 30
− 0
View file @ fe36794d
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:
doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.rst
+ 15
− 8
View file @ fe36794d
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:
......
doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.rst 0 → 100644
+ 22
− 0
View file @ fe36794d
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:
doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.rst
+ 15
− 8
View file @ fe36794d
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:
......
doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.tests.rst 0 → 100644
+ 22
− 0
View file @ fe36794d
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:
doc/source/api/force_bdss.core_plugins.dummy.rst
+ 6
− 4
View file @ fe36794d
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:
......
doc/source/api/force_bdss.core_plugins.dummy.tests.rst 0 → 100644
+ 30
− 0
View file @ fe36794d
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:
doc/source/api/force_bdss.core_plugins.rst
+ 2
− 2
View file @ fe36794d
force_bdss.core_plugins package
===============================
force\_bdss\.core\_plugins package
==================================
Subpackages
-----------
......
doc/source/api/force_bdss.data_sources.rst
+ 14
− 14
View file @ fe36794d
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:
......
doc/source/api/force_bdss.data_sources.tests.rst
+ 6
− 6
View file @ fe36794d
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:
......
doc/source/api/force_bdss.io.rst
+ 6
− 6
View file @ fe36794d
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:
......
doc/source/api/force_bdss.io.tests.rst
+ 6
− 6
View file @ fe36794d
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:
......
doc/source/api/force_bdss.kpi.rst
+ 12
− 12
View file @ fe36794d
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:
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Datenschutz und Impressum