Merge pull request #94 from MunchLab/DocumentationCleanup

Author: yemeen

.gitignore

@@ -8,6 +8,9 @@ benchmarks/results/*
 src/ect/embed_graph.py
 src/ect/embed_cw.py
 
+.vscode
+docs_local
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

Extra_Notebooks/CodingFiguresFern.ipynb

@@ -28,6 +28,12 @@ html:
 	mkdir docs
 	sphinx-build -b html doc_source docs
 
+html-local:
+	# Running sphinx-build to build html files in a local docs folder
+	rm -rf docs_local
+	mkdir docs_local
+	sphinx-build -b html doc_source docs_local 
+
 benchmark:
 	python benchmarks/run_benchmarks.py
 

Extra_Notebooks/Matisse_ECT.ipynb

@@ -10,8 +10,10 @@
 # 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.
 #
+# Add the src directory to sys.path so Sphinx can find ect.embed_complex
 import os
 import sys
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', 'src')))
 sys.path.insert(0, os.path.abspath('.'))
 sys.path.insert(0, os.path.join(os.path.dirname(__file__),'..'))
 sys.path.insert(0, os.path.join(os.path.dirname(__file__),'..', 'ect' ))
@@ -76,7 +78,7 @@
     'canonical_url': '',
     'analytics_id': 'UA-XXXXXXX-1',  #  Provided by Google in your dashboard
     'logo_only': False,
-    'display_version': True,
+    # 'display_version': True,  # Removed because it is unsupported
     'prev_next_buttons_location': 'bottom',
     'style_external_links': True,
     'style_nav_header_background': '#cececf',
@@ -100,4 +102,4 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']