added docs folder

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+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/conf.py

@@ -0,0 +1,57 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# 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('../src'))
+sys.path.insert(0, os.path.abspath('../examples'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'CuPyBe'
+copyright = '2020, SA2C'
+author = 'Michele Mesiti, Chennakesava Kadapa & SA2C'
+
+# The full version, including alpha/beta/rc tags
+release = '0.9.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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.napoleon','sphinx.ext.todo' ]
+todo_include_todos=True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+master_doc = 'index'
+
+# -- 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'
+
+# 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']

docs/index.rst

@@ -0,0 +1,36 @@
+.. MPAP documentation master file, created by
+   sphinx-quickstart on Mon Mar 23 10:59:14 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+MPAP documentation
+====================
+
+**MPAP** is a parallel solver for Fluid-Structure Interaction (FSI) problems.
+
+It is based on CutFEM for the fluid problem and uses a staggered or partitioned approach
+ for resolving the coupling between fluid and solid problems.
+
+
+
+Table of content
+++++++++++++++++
+
+.. toctree::
+   :maxdepth: 2
+
+   modules
+   examples
+
+
+Issues and bug reports
+++++++++++++++++++++++
+For issues and bug reports, please use the `Issue feature on GitHub <https://github.com/chennachaos/mpap/issues>`_. 
+In case this is inconvenient or not possible, write an email to `thechenna123@gmail.com`.
+
+License
++++++++
+
+MPAP is licensed according to the MIT license.
+
+

docs/index_conversions.rst

@@ -0,0 +1,9 @@
+Tools for index conversions
+===========================
+
+.. automodule:: index_conversions
+
+.. currentmodule:: index_conversions
+
+.. _convert-index:
+.. autofunction:: convert_index