give notebooks some love

pysal · Sep 12, 2023 · d7d3d99 · d7d3d99
1 parent af72bc5
commit d7d3d99
Show file tree

Hide file tree

Showing 15 changed files with 1,754 additions and 983 deletions.
diff --git a/docs/DirectionalLISA.nblink b/docs/DirectionalLISA.nblink
diff --git a/docs/Makefile b/docs/Makefile
@@ -17,6 +17,7 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
+	@rsync -r --exclude '.ipynb_checkpoints/' ../notebooks/ ./notebooks/
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 github:
@@ -30,3 +31,4 @@ sync:
 clean:
 	rm -rf $(BUILDDIR)/*
 	rm -rf auto_examples/
+	rm -rf generated/
diff --git a/docs/MarkovBasedMethods.nblink b/docs/MarkovBasedMethods.nblink
diff --git a/docs/MobilityMeasures.nblink b/docs/MobilityMeasures.nblink
diff --git a/docs/RankBasedMethods.nblink b/docs/RankBasedMethods.nblink
diff --git a/docs/RankMarkov.nblink b/docs/RankMarkov.nblink
diff --git a/docs/Sequence.nblink b/docs/Sequence.nblink
diff --git a/docs/conf.py b/docs/conf.py
@@ -45,7 +45,6 @@
     #'sphinx.ext.napoleon',
     "matplotlib.sphinxext.plot_directive",
     "nbsphinx",
-    "nbsphinx_link",
 ]
 
 # Configure the extension for sphinxcontrib.bibtex: set bibtex_bibfiles to the list of bib files.
@@ -118,7 +117,7 @@
 # html_theme = 'alabaster'
 html_theme = "bootstrap"
 html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
-html_title = "%s v%s Manual" % (project, version)
+html_title = f"{project} v{version} Manual"
 
 # (Optional) Logo. Should be small enough to fit the navbar (ideally 24x24).
 # Path should be relative to the ``_static`` files directory.
@@ -288,8 +287,7 @@ def setup(app):
 
 # This is processed by Jinja2 and inserted before each notebook
 nbsphinx_prolog = r"""
-{% set docname = env.doc2path(env.docname, base=None).replace("nblink","ipynb") %}
-{% set fullpath = env.doc2path(env.docname, base='tree/main/notebooks/').replace("nblink","ipynb") %}
+{% set docname = env.doc2path(env.docname, base=None) %}
 
 .. only:: html
 
@@ -302,7 +300,7 @@ def setup(app):
         Interactive online version:
         :raw-html:`<a href="https://mybinder.org/v2/gh/pysal/giddy/main?filepath={{ docname }}"><img alt="Binder badge" src="https://mybinder.org/badge_logo.svg" style="vertical-align:text-bottom"></a>`
 
-    __ https://github.com/pysal/giddy/{{ fullpath }}
+    __ https://github.com/pysal/giddy/blob/main/{{ docname }}
 
 .. raw:: latex
 
@@ -325,3 +323,8 @@ def setup(app):
     "--InlineBackend.figure_formats={'svg', 'pdf'}",
     "--InlineBackend.rc={'figure.dpi': 96}",
 ]
+
+
+mathjax3_config = {
+    "TeX": {"equationNumbers": {"autoNumber": "AMS", "useLabelIds": True}},
+}
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -5,10 +5,10 @@ Tutorial
     :maxdepth: 1
     :caption: Contents:
 
-    MarkovBasedMethods.ipynb
-    RankMarkov.ipynb
-    MobilityMeasures.ipynb
-    DirectionalLISA.ipynb
-    RankBasedMethods.ipynb
-    Sequence.ipynb
+    notebooks/MarkovBasedMethods.ipynb
+    notebooks/RankMarkov.ipynb
+    notebooks/MobilityMeasures.ipynb
+    notebooks/DirectionalLISA.ipynb
+    notebooks/RankBasedMethods.ipynb
+    notebooks/Sequence.ipynb
 
diff --git a/notebooks/DirectionalLISA.ipynb b/notebooks/DirectionalLISA.ipynb
diff --git a/notebooks/MarkovBasedMethods.ipynb b/notebooks/MarkovBasedMethods.ipynb