diff --git a/.gitignore b/.gitignore index 17ffb865de1107d2022f3318ab0c9bb7ced04388..452926b31586873ed9d208ae6e5b2abc753a1855 100644 --- a/.gitignore +++ b/.gitignore @@ -9,4 +9,5 @@ multiview_platform/Tests/temp_tests/** multiview-machine-learning-omis.iml multiview_platform.egg-inf* build* -dist* \ No newline at end of file +dist* +docs/build* \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..d45a2b8621d11110d78ed3c60384b3ffb010771c --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = MultiviewPlatform +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/source/api.rst b/docs/source/api.rst new file mode 100644 index 0000000000000000000000000000000000000000..0cc50b07d92a34044eb6790610dec05654126783 --- /dev/null +++ b/docs/source/api.rst @@ -0,0 +1,9 @@ +Multiview Platform +================== + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + + execution + monomultidoc \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..dd0b9811fd6d377cbde411c802a9668af031b04b --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,167 @@ +# -*- coding: utf-8 -*- +# +# MultiviewPlatform documentation build configuration file, created by +# sphinx-quickstart on Mon Jan 29 17:13:09 2018. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'MultiviewPlatform' +copyright = u'2018, Baptiste BAUVIN' +author = u'Baptiste BAUVIN' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'0.0.0' +# The full version, including alpha/beta/rc tags. +release = u'0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'MultiviewPlatformdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'MultiviewPlatform.tex', u'MultiviewPlatform Documentation', + u'Baptiste BAUVIN', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'multiviewplatform', u'MultiviewPlatform Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'MultiviewPlatform', u'MultiviewPlatform Documentation', + author, 'MultiviewPlatform', 'One line description of project.', + 'Miscellaneous'), +] + + + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/source/execution.rst b/docs/source/execution.rst new file mode 100644 index 0000000000000000000000000000000000000000..4c20d80fc40f258014afdad9d3f2e20dc1935eea --- /dev/null +++ b/docs/source/execution.rst @@ -0,0 +1,7 @@ +Welcome tothe exection documentation! +============================================= + +.. automodule:: multiview_platform.Exec + :members: + :inherited-members: + diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..015ec3d5cbd26ce9bcdec2e2fea6bfcfbef3a519 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,23 @@ +.. MultiviewPlatform documentation master file, created by + sphinx-quickstart on Mon Jan 29 17:13:09 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to MultiviewPlatform's documentation! +============================================= + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + + api + examples + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/monomulti/metrics.rst b/docs/source/monomulti/metrics.rst new file mode 100644 index 0000000000000000000000000000000000000000..7fc2996d26ddfc21d15e23cafa59277f652bc1cb --- /dev/null +++ b/docs/source/monomulti/metrics.rst @@ -0,0 +1,6 @@ +Welcome to the metrics documentation! +============================================= + +.. automodule:: multiview_platform.Metrics.framework + :members: + :inherited-members: \ No newline at end of file diff --git a/docs/source/monomultidoc.rst b/docs/source/monomultidoc.rst new file mode 100644 index 0000000000000000000000000000000000000000..f044acf413dc9d90f8809b1bd1b7c917d287f15a --- /dev/null +++ b/docs/source/monomultidoc.rst @@ -0,0 +1,13 @@ +Mono and mutliview classification +================================= + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + + monomutli/metrics + monomutli/monoexec + monomutli/multiexec + monomutli/monoclf + monomutli/multiclf + monomutli/utils \ No newline at end of file diff --git a/multiview_platform/Exec.py b/multiview_platform/Exec.py index e585b9fb11bbde5027a8d12d3a6d667a04ca4199..ce02d712de8212e99aeb421f12762b92889a53d9 100644 --- a/multiview_platform/Exec.py +++ b/multiview_platform/Exec.py @@ -1,3 +1,5 @@ +"""This is the execution module, used to execute the code""" + def Exec(): import Versions