Commit ea2cf20f authored by Steven Cordwell's avatar Steven Cordwell

Add basic docs covering README and API

parent 90eecbca
.. automodule:: mdptoolbox.example
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
.. automodule:: mdptoolbox.mdp
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
.. automodule:: mdptoolbox
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
.. automodule:: mdptoolbox.util
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
......@@ -20,7 +20,7 @@ import shlex
# 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.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../src'))
# -- General configuration ------------------------------------------------
......@@ -35,9 +35,14 @@ extensions = [
'sphinx.ext.doctest',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
]
# Napoleon settings
napoleon_google_docstrings = False
napoleon_use_param = True
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
......
.. Python Markov Decision Process Toolbox documentation master file, created by
sphinx-quickstart on Thu Mar 26 16:15:31 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. include:: ../README.rst
Welcome to Python Markov Decision Process Toolbox's documentation!
==================================================================
Contents:
Contents
========
.. toctree::
:maxdepth: 2
api/mdptoolbox
api/mdp
api/util
api/example
Indices and tables
==================
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment