Add sphinx documentation

Author: fvisin

.gitignore

@@ -1,4 +1,5 @@
 *.pyc
+docs/.build
 dataset_loaders.egg-info
 dataset_loaders/datasets
 .cache

README.md

@@ -3,83 +3,13 @@ for image and video semantic segmentation. The framework can perform some
 on-the-fly preprocessing/data augmentation, as well as run on multiple threads
 (if enabled) to speed up the I/O operations.
 
-NEWS: You might be interested in checking out [Main loop TF](https://github.com/fvisin/main_loop_tf), a python main loop that integrates the *Dataset loaders* with Tensorflow!
+**NEWS:** You might be interested in checking out 
+[Main loop TF](https://github.com/fvisin/main_loop_tf), a python main loop that integrates the *Dataset loaders* with Tensorflow!
 
 ### Attribution
 If you use this code, please cite:
-* \[1\] Francesco Visin, Adriana Romero - Dataset loaders: a python library to
-    load and preprocess datasets ([BibTeX](
-        https://gist.github.com/fvisin/7104500ae8b33c3b65798d5d2707ce6c#file-dataset_loaders-bib))
+* \[1\] Francesco Visin, Adriana Romero, *Dataset loaders: a python library to 
+  load and preprocess datasets* ([BibTeX](
+https://gist.github.com/fvisin/7104500ae8b33c3b65798d5d2707ce6c#file-dataset_loaders-bib))
 
-### How to install it:
-1. Clone the repository with `--recursive` in some path, e.g. to your `$HOME`:
-
-   ```sh
-   git clone --recursive https://github.com/fvisin/dataset_loaders.git "$HOME/dataset_loaders"
-   ```
-
-2. Install the package:
-
-   ```sh
-   pip install [--user] -e <dataset_loaders path>
-   ```
-
-3. The framework assumes that the datasets are stored in some *shared paths*,
-   accessible by everyone, and should be copied locally on the machines that
-   run the experiments. The framework automatically takes care for you to copy
-   the datasets from the *shared paths* to a *local path*. 
-
-   Create a configuration file with these paths in 
-   `/dataset_loaders/dataset_loaders/config.ini` (see the 
-   [config.ini.example](dataset_loaders/config.ini.example) in the same 
-   directory for guidance).
-
-   Note: if you want to disable the copy mechanism, just specify the same path 
-   for the local and the shared path:
-
-   ```ini
-   [general]
-   datasets_local_path = /a/local/path
-   [camvid]
-   shared_path = /a/local/path/camvid
-   [cityscapes]
-   shared_path = /a/local/path/cityscapes/
-   (and so on...)
-   ```
-
-4. To use the MS COCO dataset, you also need to do the following:
-
-   ```sh
-   cd dataset_loaders/images/coco/PythonAPI
-   make all
-   ```
-
-4. You will need to install
-   [SimpleITK](https://itk.org/Wiki/SimpleITK/GettingStarted#Generic_Distribution)
-   and [openCV](http://opencv.org/) if you intend to use the *warp_spline* or
-   the *optical flow* data augmentations respectively.
-</br>
-
-### Notes
-* **The code is provided as is, please expect minimal-to-none support on it.**
-* This framework is provided for research purposes only. Although we tried our 
-  best to test it, the code might be bugged or unstable. Use it at your own
-  risk!
-* The framework currently supports image or video based datasets. It could be 
-  easily extended to support other kinds of data (e.g., text corpora), but
-  there is no plan on our side to work on that at the moment.
-* Feel free to contribute to the code with a PR if you find bugs, want to
-  improve the existing code or add support for other datasets.
-
- 
-</br>
-</br>
-</br>
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
-OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
+Check the full documentation on: http://dataset_loaders.readthedocs.io

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    = Datasetloaders
+SOURCEDIR     = .
+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)

docs/api.rst

@@ -0,0 +1,12 @@
+.. _api:
+
+API
+===
+
+.. toctree::
+
+    parallel_loader 
+    images 
+    videos 
+    utilities
+

docs/conf.py

@@ -0,0 +1,230 @@
+# -*- coding: utf-8 -*-
+#
+# Dataset loaders documentation build configuration file, created by
+# sphinx-quickstart on Thu Jun 22 11:26:05 2017.
+#
+# 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('.'))
+
+import os
+import sys
+from recommonmark.parser import CommonMarkParser
+import sphinx_rtd_theme
+
+import dataset_loaders
+
+# Use read the docs theme locally
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# Parse Markdown syntax
+source_parsers = {
+        '.md': CommonMarkParser,
+}
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = ['.rst', '.md']
+
+
+# -- 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.intersphinx',
+              'sphinx.ext.mathjax',
+              'sphinx.ext.viewcode',
+              'sphinx.ext.githubpages',
+              # 'sphinx.ext.todo',
+              # 'sphinx.ext.doctest',
+              'sphinx.ext.napoleon',
+              'sphinx.ext.linkcode']
+              # 'sphinxcontrib.napoleon']
+
+napoleon_google_docstring = False
+napoleon_include_special_with_doc = False
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['.templates']
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Dataset loaders'
+copyright = u'2017, Francesco Visin and Adriana Romero'
+author = u'Francesco Visin and Adriana Romero'
+
+# 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'1.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.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 = ['.build', 'Thumbs.db', '.DS_Store']
+
+# 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 = False
+
+
+# Options for the linkcode extension
+# ----------------------------------
+# Resolve function
+# This function is used to populate the (source) links in the API
+def linkcode_resolve(domain, info):
+    def find_source():
+        # try to find the file and line number, based on code from numpy:
+        # https://github.com/numpy/numpy/blob/master/doc/source/conf.py#L286
+        obj = sys.modules[info['module']]
+        for part in info['fullname'].split('.'):
+            obj = getattr(obj, part)
+        import inspect
+        fn = inspect.getsourcefile(obj)
+        fn = os.path.relpath(fn,
+                             start=os.path.dirname(dataset_loaders.__file__))
+        source, lineno = inspect.getsourcelines(obj)
+        return fn, lineno, lineno + len(source) - 1
+
+    if domain != 'py' or not info['module']:
+        return None
+    try:
+        filename = 'dataset_loaders/%s#L%d-L%d' % find_source()
+    except Exception:
+        filename = info['module'].replace('.', '/') + '.py'
+    import subprocess
+    tag = subprocess.Popen(['git', 'rev-parse', 'HEAD'],
+                           stdout=subprocess.PIPE,
+                           universal_newlines=True).communicate()[0][:-1]
+    return "https://github.com/fvisin/dataset_loaders/blob/%s/%s" % (tag, filename)
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The html-style
+#
+# html_style = '/default.css'
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# Read the docs style:
+if os.environ.get('READTHEDOCS') != 'True':
+    try:
+        import sphinx_rtd_theme
+    except ImportError:
+        pass  # assume we have sphinx >= 1.3
+    else:
+        html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+        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']
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+html_use_smartypants = True
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Datasetloadersdoc'
+
+
+# -- 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, 'Datasetloaders.tex', u'Dataset loaders Documentation',
+     u'Francesco Visin and Adriana Romero', '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, 'datasetloaders', u'Dataset loaders 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, 'Datasetloaders', u'Dataset loaders Documentation',
+     author, 'Datasetloaders', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+# intersphinx_mapping = {'https://docs.python.org/': None}