Merge pull request #95 from scikit-tda/master

Docs build for gh-pages

Makefile

@@ -0,0 +1,11 @@
+# make gh-pages in repo base directory to automatically build and deploy documents to github
+
+gh-pages:
+	echo "Make gh-pages"
+	cd doc; make html
+	git checkout gh-pages
+	rm -rf _sources _static _modules _downloads _images auto_examples
+	mv -fv doc/_build/html/* .
+	rm -rf doc
+	git add -A
+	git commit -m "Generated gh-pages for `git log master -1 --pretty=short --abbrev-commit`" && git push origin gh-pages ; git checkout master

doc/.gitignore

@@ -0,0 +1,7 @@
+venv
+umap
+setup.py
+paper.md
+paper.bib
+LICENSE.txt
+CODE_OF_CONDUCT.md

doc/conf.py

@@ -88,7 +88,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 = 'alabaster'
 html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
@@ -102,13 +102,23 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+
+
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #
 # This is required for the alabaster theme
 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+# html_sidebars = {
+#     '**': [
+#         'relations.html',  # needs 'show_related': True theme option to display
+#         'searchbox.html',
+#     ]
+# }
+
 html_sidebars = {
     '**': [
+        'globaltoc.html',
         'relations.html',  # needs 'show_related': True theme option to display
         'searchbox.html',
     ]

docs_requirements.txt

@@ -0,0 +1,5 @@
+sphinx
+sphinx_gallery
+matplotlib
+pillow
+sphinx_rtd_theme