update docs

docs/conf.py

@@ -35,6 +35,7 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
+    'nbsphinx',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -50,7 +51,7 @@
     '.md': CommonMarkParser,
 }
 
-source_suffix = ['.rst', '.md']
+source_suffix = ['.rst', '.md', '.ipynb']
 #source_suffix = '.rst'
 
 # The encoding of source files.
@@ -132,7 +133,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'nature'
 
 # 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

docs/examples.rst

@@ -0,0 +1,46 @@
+survivalstan package
+====================
+
+Submodules
+----------
+
+survivalstan.models module
+--------------------------
+
+.. automodule:: survivalstan.models
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+survivalstan.sim module
+-----------------------
+
+.. automodule:: survivalstan.sim
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+survivalstan.survivalstan module
+--------------------------------
+
+.. automodule:: survivalstan.survivalstan
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+survivalstan.utils module
+-------------------------
+
+.. automodule:: survivalstan.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: survivalstan
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/index.rst

@@ -39,7 +39,7 @@ Features
 Installation
 ------------
 
-Install $survivalstan via pip:
+Install survivalstan via pip:
 
     pip install survivalstan
 
@@ -67,6 +67,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   Usage.ipynb
 
 Indices and tables
 ==================