diff --git a/doc/Makefile b/doc/Makefile index a054e8cc4a922ed63aafc65cf08a4a67c0d14571..5c416f24486fd37891681c848969f92b4dcd8bcb 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -51,38 +51,38 @@ clean: rm -rf $(BUILDDIR)/* html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + $(SPHINXBUILD) -W -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + $(SPHINXBUILD) -W -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + $(SPHINXBUILD) -W -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + $(SPHINXBUILD) -W -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + $(SPHINXBUILD) -W -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + $(SPHINXBUILD) -W -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + $(SPHINXBUILD) -W -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @@ -91,7 +91,7 @@ qthelp: @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SimPhoNy.qhc" devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + $(SPHINXBUILD) -W -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @@ -100,80 +100,80 @@ devhelp: @echo "# devhelp" epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + $(SPHINXBUILD) -W -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + $(SPHINXBUILD) -W -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + $(SPHINXBUILD) -W -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + $(SPHINXBUILD) -W -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + $(SPHINXBUILD) -W -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + $(SPHINXBUILD) -W -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + $(SPHINXBUILD) -W -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + $(SPHINXBUILD) -W -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + $(SPHINXBUILD) -W -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + $(SPHINXBUILD) -W -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + $(SPHINXBUILD) -W -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + $(SPHINXBUILD) -W -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + $(SPHINXBUILD) -W -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml @echo @echo "Build finished. The XML files are in $(BUILDDIR)/xml." pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + $(SPHINXBUILD) -W -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." 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 0000000000000000000000000000000000000000..0d3491bb8020a5033b5c8f113a41e969d6af6693 --- /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 9855728ad131b97dced0c75b7475654a5e3766b7..6476239ac3951c1b2f5ebef36b3a1172e81fd265 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 8b2a6e33dc0f4d464f7f10a9130d930f9ad53a85..c8047b33691b51c57d8f3ac75629b1c6f206f8ff 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 9eb3cabfbc9be6083e0cc1e618267aa4fe82b955..6dbcf8432a56e54097c8d928f481e2ee23fed06b 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 d78f9d359df54ee71bfe7a117a086d75f9719589..149a14bb7187eda808fdadcb8a5b8f59d5d73ed5 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 ---------------------------------------------------