get readthedocs working

docs/api.rst

@@ -4,12 +4,12 @@ API Summary
    :toctree: _autosummary
    :template: modules.rst
 
-   mrpy.special
-   mrpy.stats
-   mrpy.core
-   mrpy.physical_dependence
-   mrpy.likelihoods
-   mrpy.analytic_model
-   mrpy.fit_curve
-   mrpy.fit_perobj
-   mrpy.reparameterise
+   mrpy.base.special
+   mrpy.base.stats
+   mrpy.base.core
+   mrpy.extra.physical_dependence
+   mrpy.extra.likelihoods
+   mrpy.extra.analytic_model
+   mrpy.extra.reparameterise
+   mrpy.fitting.fit_curve
+   mrpy.fitting.fit_sample

docs/conf.py

@@ -38,7 +38,8 @@
     'sphinx.ext.viewcode',
     'sphinx.ext.autosummary',
     'numpydoc',
-#    'nbsphinx'
+    'nbsphinx',
+    'IPython.sphinxext.ipython_console_highlighting'  # Ensures syntax highlighting works in notebooks (workaround)
 ]
 
 autosummary_generate = "api",
@@ -317,36 +318,36 @@ def find_version(*file_paths):
 intersphinx_mapping = {'https://docs.python.org/': None}
 numpydoc_show_class_members=False
 
-
-#===============================================================================
-# This does something naughty. It runs the nbconvert command on everything in the
-# given folder, and moves the results to another given folder on every make.
-
-source_ipy_folder = "examples"
-output_ipy_folder = "_exampledoc"
-import shutil
-
-def nbconvert_files(app):
-    fin = app.config.source_ipy_folder
-    fout = app.config.output_ipy_folder
-
-    if os.path.exists(fout):
-        os.system("rm -rf %s"%fout)
-
-    os.mkdir(fout)
-
-    files = [f for f in os.listdir(fin) if f.endswith(".ipynb")]
-
-    for f in files:
-        os.system("jupyter nbconvert {0} --to rst".format(os.path.join(fin,f)))
-        os.rename(f.replace(".ipynb",".rst"),os.path.join(fout,f.replace(".ipynb",".rst")))
-        try:
-            shutil.move(f.replace(".ipynb","_files"),os.path.join(fout,f.replace(".ipynb","_files")))
-        except IOError:
-            pass
-
-def setup(app):
-    app.add_config_value("source_ipy_folder","examples","html")
-    app.add_config_value("output_ipy_folder","_exampledoc","html")
-
-    app.connect("builder-inited",nbconvert_files)
+#
+# #===============================================================================
+# # This does something naughty. It runs the nbconvert command on everything in the
+# # given folder, and moves the results to another given folder on every make.
+#
+# source_ipy_folder = "examples"
+# output_ipy_folder = "_exampledoc"
+# import shutil
+#
+# def nbconvert_files(app):
+#     fin = app.config.source_ipy_folder
+#     fout = app.config.output_ipy_folder
+#
+#     if os.path.exists(fout):
+#         os.system("rm -rf %s"%fout)
+#
+#     os.mkdir(fout)
+#
+#     files = [f for f in os.listdir(fin) if f.endswith(".ipynb")]
+#
+#     for f in files:
+#         os.system("jupyter nbconvert {0} --to rst".format(os.path.join(fin,f)))
+#         os.rename(f.replace(".ipynb",".rst"),os.path.join(fout,f.replace(".ipynb",".rst")))
+#         try:
+#             shutil.move(f.replace(".ipynb","_files"),os.path.join(fout,f.replace(".ipynb","_files")))
+#         except IOError:
+#             pass
+#
+# def setup(app):
+#     app.add_config_value("source_ipy_folder","examples","html")
+#     app.add_config_value("output_ipy_folder","_exampledoc","html")
+#
+#     app.connect("builder-inited",nbconvert_files)

docs/example_toc.rst

@@ -19,6 +19,4 @@ the API documentation for each object.
    _exampledoc/reparameterization_performance
    _exampledoc/SMHM
    _exampledoc/double_schechter_gsmf
-   _exampledoc/test_performance_against_EPS
-
 

docs/requirements.txt

@@ -1,4 +1,6 @@
 numpydoc
 nbsphinx
 ipykernel
-pandoc
+pandoc
+nbsphinx
+ipykernel