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

Cleanup of documentation

parent a2dbeafe
No related branches found
No related tags found
1 merge request!101Create probe classes for tests
Hide whitespace changes
Inline Side-by-side
Showing
with 5 additions and 660 deletions
doc/source/api/force_bdss.cli.tests.rst deleted 100644 → 0
+ 0
− 22
View file @ a2dbeafe
force\_bdss\.cli\.tests package
===============================
Submodules
----------
force\_bdss\.cli\.tests\.test\_execution module
-----------------------------------------------
.. automodule:: force_bdss.cli.tests.test_execution
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: force_bdss.cli.tests
:members:
:undoc-members:
:show-inheritance:
doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.rst deleted 100644 → 0
+ 0
− 45
View file @ a2dbeafe
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\_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\_factory module
---------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_factory
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.csv\_extractor\_model module
-------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_model
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: force_bdss.core_plugins.dummy.csv_extractor
:members:
:undoc-members:
:show-inheritance:
doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.tests.rst deleted 100644 → 0
+ 0
− 30
View file @ a2dbeafe
force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.tests package
================================================================
Submodules
----------
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:
force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.tests\.test\_csv\_extractor\_factory module
----------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.csv_extractor.tests.test_csv_extractor_factory
: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 deleted 100644 → 0
+ 0
− 61
View file @ a2dbeafe
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\_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\_factory module
------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.dakota_factory
:members:
:undoc-members:
:show-inheritance:
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
--------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.dakota_optimizer
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.parameters module
-------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.parameters
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota
:members:
:undoc-members:
:show-inheritance:
doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.tests.rst deleted 100644 → 0
+ 0
− 38
View file @ a2dbeafe
force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.tests package
===============================================================
Submodules
----------
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:
force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.tests\.test\_dakota\_factory module
-------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.tests.test_dakota_factory
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.tests\.test\_dakota\_optimizer module
---------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.tests.test_dakota_optimizer
: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 deleted 100644 → 0
+ 0
− 45
View file @ a2dbeafe
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\_factory module
-------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.dummy_data_source_factory
: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 deleted 100644 → 0
+ 0
− 30
View file @ a2dbeafe
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\_factory module
--------------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.tests.test_dummy_data_source_factory
: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 deleted 100644 → 0
+ 0
− 45
View file @ a2dbeafe
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
----------------------------------------------------------------------------------------
.. 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\_factory module
-------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator_factory
:members:
:undoc-members:
:show-inheritance:
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:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator
:members:
:undoc-members:
:show-inheritance:
doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.rst deleted 100644 → 0
+ 0
− 30
View file @ a2dbeafe
force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.tests package
========================================================================
Submodules
----------
force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.tests\.test\_dummy\_kpi\_calculator module
-----------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.test_dummy_kpi_calculator
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.tests\.test\_dummy\_kpi\_calculator\_factory module
--------------------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.test_dummy_kpi_calculator_factory
: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.dummy_notification_listener.rst deleted 100644 → 0
+ 0
− 45
View file @ a2dbeafe
force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener package
========================================================================
Subpackages
-----------
.. toctree::
force_bdss.core_plugins.dummy.dummy_notification_listener.tests
Submodules
----------
force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.dummy\_notification\_listener module
------------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.dummy_notification_listener
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.dummy\_notification\_listener\_factory module
---------------------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.dummy_notification_listener_factory
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.dummy\_notification\_listener\_model module
-------------------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.dummy_notification_listener_model
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener
:members:
:undoc-members:
:show-inheritance:
doc/source/api/force_bdss.core_plugins.dummy.dummy_notification_listener.tests.rst deleted 100644 → 0
+ 0
− 38
View file @ a2dbeafe
force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.tests package
===============================================================================
Submodules
----------
force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.tests\.test\_dummy\_notification\_listener module
-------------------------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.tests.test_dummy_notification_listener
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.tests\.test\_dummy\_notification\_listener\_factory module
----------------------------------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.tests.test_dummy_notification_listener_factory
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.tests\.test\_dummy\_notification\_listener\_model module
--------------------------------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.tests.test_dummy_notification_listener_model
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.tests
:members:
:undoc-members:
:show-inheritance:
doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.rst deleted 100644 → 0
+ 0
− 45
View file @ a2dbeafe
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\_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\_factory module
-------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_factory
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.kpi\_adder\_model module
-----------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_model
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: force_bdss.core_plugins.dummy.kpi_adder
:members:
:undoc-members:
:show-inheritance:
doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.tests.rst deleted 100644 → 0
+ 0
− 30
View file @ a2dbeafe
force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.tests package
============================================================
Submodules
----------
force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.tests\.test\_kpi\_adder\_calculator module
-----------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.kpi_adder.tests.test_kpi_adder_calculator
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.tests\.test\_kpi\_adder\_factory module
--------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.kpi_adder.tests.test_kpi_adder_factory
: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.power_evaluator.rst deleted 100644 → 0
+ 0
− 45
View file @ a2dbeafe
force\_bdss\.core\_plugins\.dummy\.power\_evaluator package
===========================================================
Subpackages
-----------
.. toctree::
force_bdss.core_plugins.dummy.power_evaluator.tests
Submodules
----------
force\_bdss\.core\_plugins\.dummy\.power\_evaluator\.power\_evaluator\_data\_source module
------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.power_evaluator.power_evaluator_data_source
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.power\_evaluator\.power\_evaluator\_factory module
-------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.power_evaluator.power_evaluator_factory
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.power\_evaluator\.power\_evaluator\_model module
-----------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.power_evaluator.power_evaluator_model
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: force_bdss.core_plugins.dummy.power_evaluator
:members:
:undoc-members:
:show-inheritance:
doc/source/api/force_bdss.core_plugins.dummy.power_evaluator.tests.rst deleted 100644 → 0
+ 0
− 30
View file @ a2dbeafe
force\_bdss\.core\_plugins\.dummy\.power\_evaluator\.tests package
==================================================================
Submodules
----------
force\_bdss\.core\_plugins\.dummy\.power\_evaluator\.tests\.test\_power\_evaluator\_data\_source module
-------------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.power_evaluator.tests.test_power_evaluator_data_source
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.power\_evaluator\.tests\.test\_power\_evaluator\_factory module
--------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.power_evaluator.tests.test_power_evaluator_factory
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: force_bdss.core_plugins.dummy.power_evaluator.tests
:members:
:undoc-members:
:show-inheritance:
doc/source/api/force_bdss.core_plugins.dummy.rst deleted 100644 → 0
+ 0
− 36
View file @ a2dbeafe
force\_bdss\.core\_plugins\.dummy package
=========================================
Subpackages
-----------
.. toctree::
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.dummy_notification_listener
force_bdss.core_plugins.dummy.kpi_adder
force_bdss.core_plugins.dummy.power_evaluator
force_bdss.core_plugins.dummy.tests
Submodules
----------
force\_bdss\.core\_plugins\.dummy\.dummy\_plugin module
-------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_plugin
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: force_bdss.core_plugins.dummy
:members:
:undoc-members:
:show-inheritance:
doc/source/api/force_bdss.core_plugins.dummy.tests.rst deleted 100644 → 0
+ 0
− 38
View file @ a2dbeafe
force\_bdss\.core\_plugins\.dummy\.tests package
================================================
Submodules
----------
force\_bdss\.core\_plugins\.dummy\.tests\.data\_source\_factory\_test\_mixin module
-----------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.tests.data_source_factory_test_mixin
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.tests\.kpi\_calculator\_factory\_test\_mixin module
--------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.tests.kpi_calculator_factory_test_mixin
:members:
:undoc-members:
:show-inheritance:
force\_bdss\.core\_plugins\.dummy\.tests\.test\_direct\_execution module
------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.tests.test_direct_execution
: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
+ 0
− 7
View file @ 5cd52acd
force\_bdss\.core\_plugins package
==================================
Subpackages
-----------
.. toctree::
force_bdss.core_plugins.dummy
Module contents
---------------
......
doc/source/api/force_bdss.tests.rst
+ 1
− 0
View file @ 5cd52acd
......@@ -7,6 +7,7 @@ Subpackages
.. toctree::
force_bdss.tests.fixtures
force_bdss.tests.probe_classes
Submodules
----------
......
force_bdss/core_plugins/__init__.py 0 → 100644
+ 4
− 0
View file @ 5cd52acd
"""
Here we host the core plugins. They ship with the BDSS and are always
available. They provide a form of "standard library" of functionality.
"""
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