Added doc infrastructure

3e434896 · Stefano Borini · 79f77ad5 · 3e434896 · 3e434896 · 3e434896
Commit 3e434896 authored 7 years ago by Stefano Borini
--- a/README.md
+++ b/README.md
@@ -3,6 +3,3 @@ FORCE BDSS

 This repository contains the implementation of the Business Decision System. It is implemented
 under the FORCE project (Horizon 2020/NMBP-23-2016/721027).
-
-
-
--- a/docs/Makefile
+++ b/docs/Makefile
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext uml
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  uml        to convert all uml files into images"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -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
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SimPhoNy.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SimPhoNy.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/SimPhoNy"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SimPhoNy"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -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
+	@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
+	@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
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -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
+	@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
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -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
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+
+.PHONY: uml
+uml:
+	java -jar plantuml.jar "source/uml/" "source/images"
+	mv source/uml/*.png source/images
+	@echo
+	@echo "Conversion finished the uml files are in source/images."
+
+.PHONY: apidoc
+apidoc:
+	-rm -rf source/api/
+	sphinx-apidoc -o source/api ../force_bdss
--- a/docs/make.bat
+++ b/docs/make.bat
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
+set I18NSPHINXOPTS=%SPHINXOPTS% source
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html       to make standalone HTML files
+	echo.  dirhtml    to make HTML files named index.html in directories
+	echo.  singlehtml to make a single large HTML file
+	echo.  pickle     to make pickle files
+	echo.  json       to make JSON files
+	echo.  htmlhelp   to make HTML files and a HTML help project
+	echo.  qthelp     to make HTML files and a qthelp project
+	echo.  devhelp    to make HTML files and a Devhelp project
+	echo.  epub       to make an epub
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  texinfo    to make Texinfo files
+	echo.  gettext    to make PO message catalogs
+	echo.  changes    to make an overview over all changed/added/deprecated items
+	echo.  xml        to make Docutils-native XML files
+	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
+	echo.  linkcheck  to check all external links for integrity
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
+	echo.  uml        to convert all uml files into images
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\SimPhoNy.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\SimPhoNy.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "latexpdf" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	cd %BUILDDIR%/latex
+	make all-pdf
+	cd %BUILDDIR%/..
+	echo.
+	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "latexpdfja" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	cd %BUILDDIR%/latex
+	make all-pdf-ja
+	cd %BUILDDIR%/..
+	echo.
+	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "texinfo" (
+	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+	goto end
+)
+
+if "%1" == "gettext" (
+	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+if "%1" == "xml" (
+	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The XML files are in %BUILDDIR%/xml.
+	goto end
+)
+
+if "%1" == "pseudoxml" (
+	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
+	goto end
+)
+
+if "%1" == "uml" (
+	java -jar plantuml.jar "source/uml/" "source/images"
+	move source\uml\*.png source\images
+	if errorlevel 1 exit /b 1)
+	echo.
+	echo.Coversion finished the uml files are in source/images.
+	goto end
+
+:end
--- a/docs/source/_static/force_logo.png
+++ b/docs/source/_static/force_logo.png
--- a/docs/source/api/force_bdss.cli.rst
+++ b/docs/source/api/force_bdss.cli.rst
+force_bdss.cli package
+======================
+
+Submodules
+----------
+
+force_bdss.cli.force_bdss module
+--------------------------------
+
+.. automodule:: force_bdss.cli.force_bdss
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.cli
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/api/force_bdss.core_plugins.csv_extractor.csv_extractor.rst
+++ b/docs/source/api/force_bdss.core_plugins.csv_extractor.csv_extractor.rst
+force_bdss.core_plugins.csv_extractor.csv_extractor package
+===========================================================
+
+Submodules
+----------
+
+force_bdss.core_plugins.csv_extractor.csv_extractor.csv_extractor_bundle module
+-------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.csv_extractor.csv_extractor.csv_extractor_bundle
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.core_plugins.csv_extractor.csv_extractor.csv_extractor_data_source module
+------------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.csv_extractor.csv_extractor.csv_extractor_data_source
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.core_plugins.csv_extractor.csv_extractor.csv_extractor_model module
+------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.csv_extractor.csv_extractor.csv_extractor_model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.core_plugins.csv_extractor.csv_extractor
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/api/force_bdss.core_plugins.csv_extractor.rst
+++ b/docs/source/api/force_bdss.core_plugins.csv_extractor.rst
+force_bdss.core_plugins.csv_extractor package
+=============================================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    force_bdss.core_plugins.csv_extractor.csv_extractor
+
+Submodules
+----------
+
+force_bdss.core_plugins.csv_extractor.csv_extractor_plugin module
+-----------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.csv_extractor.csv_extractor_plugin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.core_plugins.csv_extractor
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/api/force_bdss.core_plugins.rst
+++ b/docs/source/api/force_bdss.core_plugins.rst
+force_bdss.core_plugins package
+===============================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    force_bdss.core_plugins.csv_extractor
+    force_bdss.core_plugins.test_kpi
+    force_bdss.core_plugins.test_mco
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.core_plugins
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/api/force_bdss.core_plugins.test_kpi.kpi_adder.rst
+++ b/docs/source/api/force_bdss.core_plugins.test_kpi.kpi_adder.rst
+force_bdss.core_plugins.test_kpi.kpi_adder package
+==================================================
+
+Submodules
+----------
+
+force_bdss.core_plugins.test_kpi.kpi_adder.kpi_adder_bundle module
+------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.test_kpi.kpi_adder.kpi_adder_bundle
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.core_plugins.test_kpi.kpi_adder.kpi_adder_calculator module
+----------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.test_kpi.kpi_adder.kpi_adder_calculator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.core_plugins.test_kpi.kpi_adder.kpi_adder_model module
+-----------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.test_kpi.kpi_adder.kpi_adder_model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.core_plugins.test_kpi.kpi_adder
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/api/force_bdss.core_plugins.test_kpi.rst
+++ b/docs/source/api/force_bdss.core_plugins.test_kpi.rst
+force_bdss.core_plugins.test_kpi package
+========================================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    force_bdss.core_plugins.test_kpi.kpi_adder
+
+Submodules
+----------
+
+force_bdss.core_plugins.test_kpi.test_kpi_calculator_plugin module
+------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.test_kpi.test_kpi_calculator_plugin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.core_plugins.test_kpi
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/api/force_bdss.core_plugins.test_mco.dakota.rst
+++ b/docs/source/api/force_bdss.core_plugins.test_mco.dakota.rst
+force_bdss.core_plugins.test_mco.dakota package
+===============================================
+
+Submodules
+----------
+
+force_bdss.core_plugins.test_mco.dakota.dakota_bundle module
+------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.test_mco.dakota.dakota_bundle
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.core_plugins.test_mco.dakota.dakota_communicator module
+------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.test_mco.dakota.dakota_communicator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.core_plugins.test_mco.dakota.dakota_model module
+-----------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.test_mco.dakota.dakota_model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.core_plugins.test_mco.dakota.dakota_optimizer module
+---------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.test_mco.dakota.dakota_optimizer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.core_plugins.test_mco.dakota
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/api/force_bdss.core_plugins.test_mco.rst
+++ b/docs/source/api/force_bdss.core_plugins.test_mco.rst
+force_bdss.core_plugins.test_mco package
+========================================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    force_bdss.core_plugins.test_mco.dakota
+
+Submodules
+----------
+
+force_bdss.core_plugins.test_mco.multi_criteria_optimizers_plugin module
+------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.test_mco.multi_criteria_optimizers_plugin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.core_plugins.test_mco
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/api/force_bdss.data_sources.rst
+++ b/docs/source/api/force_bdss.data_sources.rst
+force_bdss.data_sources package
+===============================
+
+Submodules
+----------
+
+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_model module
+-----------------------------------------------------
+
+.. automodule:: force_bdss.data_sources.base_data_source_model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+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
+-------------------------------------------------
+
+.. automodule:: force_bdss.data_sources.data_source_result
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.data_sources.i_data_source_bundle module
+---------------------------------------------------
+
+.. automodule:: force_bdss.data_sources.i_data_source_bundle
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.data_sources
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/api/force_bdss.kpi.rst
+++ b/docs/source/api/force_bdss.kpi.rst
+force_bdss.kpi package
+======================
+
+Submodules
+----------
+
+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_model module
+-----------------------------------------------
+
+.. automodule:: force_bdss.kpi.base_kpi_calculator_model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+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
+-------------------------------------------
+
+.. automodule:: force_bdss.kpi.kpi_calculator_result
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.kpi
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/api/force_bdss.mco.rst
+++ b/docs/source/api/force_bdss.mco.rst
+force_bdss.mco package
+======================
+
+Submodules
+----------
+
+force_bdss.mco.base_mco_communicator module
+-------------------------------------------
+
+.. automodule:: force_bdss.mco.base_mco_communicator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.mco.base_mco_model module
+------------------------------------
+
+.. automodule:: force_bdss.mco.base_mco_model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.mco.base_multi_criteria_optimizer module
+---------------------------------------------------
+
+.. automodule:: force_bdss.mco.base_multi_criteria_optimizer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.mco.i_multi_criteria_optimizer_bundle module
+-------------------------------------------------------
+
+.. automodule:: force_bdss.mco.i_multi_criteria_optimizer_bundle
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.mco
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/api/force_bdss.rst
+++ b/docs/source/api/force_bdss.rst
+force_bdss package
+==================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    force_bdss.cli
+    force_bdss.core_plugins
+    force_bdss.data_sources
+    force_bdss.kpi
+    force_bdss.mco
+    force_bdss.workspecs
+
+Submodules
+----------
+
+force_bdss.base_core_driver module
+----------------------------------
+
+.. automodule:: force_bdss.base_core_driver
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.bdss_application module
+----------------------------------
+
+.. automodule:: force_bdss.bdss_application
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.core_evaluation_driver module
+----------------------------------------
+
+.. automodule:: force_bdss.core_evaluation_driver
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.core_mco_driver module
+---------------------------------
+
+.. automodule:: force_bdss.core_mco_driver
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/api/force_bdss.workspecs.rst
+++ b/docs/source/api/force_bdss.workspecs.rst
+force_bdss.workspecs package
+============================
+
+Submodules
+----------
+
+force_bdss.workspecs.data_source module
+---------------------------------------
+
+.. automodule:: force_bdss.workspecs.data_source
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.workspecs.kpi_calculator module
+------------------------------------------
+
+.. automodule:: force_bdss.workspecs.kpi_calculator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.workspecs.multi_criteria_optimizer module
+----------------------------------------------------
+
+.. automodule:: force_bdss.workspecs.multi_criteria_optimizer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+force_bdss.workspecs.workflow module
+------------------------------------
+
+.. automodule:: force_bdss.workspecs.workflow
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.workspecs
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/api/modules.rst
+++ b/docs/source/api/modules.rst
+force_bdss
+==========
+
+.. toctree::
+   :maxdepth: 4
+
+   force_bdss
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
+# -*- coding: utf-8 -*-
+
+import sphinx.environment
+from docutils.utils import get_source_line
+
+MOCK_MODULES=[]
+
+def _warn_node(self, msg, node, **kwargs):
+    if not msg.startswith('nonlocal image URI found:'):
+        self._warnfunc(msg, '%s:%s' % get_source_line(node), **kwargs)
+
+sphinx.environment.BuildEnvironment.warn_node = _warn_node
+
+def mock_modules():
+    import sys
+
+    from mock import MagicMock
+
+    try:
+        import numpy
+    except ImportError:
+        MOCK_MODULES.append('numpy')
+
+    class Mock(MagicMock):
+        @classmethod
+        def __getattr__(cls, name):
+            return Mock()
+
+        def __call__(self, *args, **kwards):
+            return Mock()
+
+    sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+    print 'mocking {}'.format(MOCK_MODULES)
+
+mock_modules()
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.napoleon',
+]
+
+templates_path = ['_templates']
+source_suffix = '.rst'
+master_doc = 'index'
+project = u'FORCE'
+copyright = u'2017, FORCE Project'
+version = '0.1.0'
+release = '0.1.0.dev0'
+pygments_style = 'sphinx'
+html_theme = 'classic'
+html_static_path = ['_static']
+html_logo = '_static/force_logo.png'
+htmlhelp_basename = 'FORCEdoc'
+intersphinx_mapping = {'http://docs.python.org/': None}
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
+Welcome to FORCE BDSS documentation!
+====================================
+
+.. include:: ../../README.rst
+
+User Manual
+===========
+
+.. toctree::
+   :maxdepth: 1
+
+   Introduction <introduction>
+
+
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   api/modules
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`