DOC Add verification study (close #1)

andsor · Nov 21, 2015 · dcc72e8 · dcc72e8
1 parent dec7025
commit dcc72e8
Show file tree

Hide file tree

Showing 7 changed files with 890 additions and 0 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -3,3 +3,5 @@ tutorial.rst
 tutorial_files/
 Untitled*.ipynb
 reference
+verification.rst
+verification_files/
diff --git a/docs/_static/bond-percolation-hpc-chain-canonical-averages.hdf5 b/docs/_static/bond-percolation-hpc-chain-canonical-averages.hdf5
diff --git a/docs/_static/bond-percolation-hpc-grid-canonical-averages.hdf5 b/docs/_static/bond-percolation-hpc-grid-canonical-averages.hdf5
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1,6 +1,9 @@
 Changelog
 =========
 
+* :release:`0.7.0 <2015-11-21>`
+* :feature:`1` Add verification study
+
 * :release:`0.6.2 <2015-11-14>`
 * :bug:`0` Fix changelog
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -36,6 +36,7 @@ def __getattr__(cls, name):
 MOCK_MODULES = [
     'numpy', 'numpy.ma', 'scipy', 'scipy.stats', 'scipy.optimize',
     'scipy.optimize.optimize', 'matplotlib',
+    'h5py', 'seaborn', 'cycler',
 ]
 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
 
@@ -67,6 +68,18 @@ def __getattr__(cls, name):
     shell=True
 )
 
+# convert verification study to rst
+IPYTHON = (
+    'ipython' if not on_rtd
+    else
+    '/home/docs/checkouts/readthedocs.org/user_builds/pyfssa/envs/latest/bin/ipython3'
+)
+
+subprocess.call(
+    "{} nbconvert --to rst --template _static/rst.tpl verification.ipynb".format(IPYTHON),
+    shell=True
+)
+
 
 # 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