change docs from RTD to github page

pysal · Mar 4, 2023 · 08a7ada · 08a7ada
1 parent ae70fbd
commit 08a7ada
Show file tree

Hide file tree

Showing 16 changed files with 19 additions and 10 deletions.
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
@@ -3,8 +3,8 @@
 # Notes:
 #   - After the first run of this workflow:
 #       - Within the project repo, navigate to Setting/Github Pages
-#       - set `the source pbranch to `gh-pages/(root))`.
-#   - Uncomment evertything below the following line to enable the workflow.
+#       - set `the source branch to `gh-pages/(root))`.
+#   - Uncomment everything below the following line to enable the workflow.
 #---------------------------------------------------------------------------
 
  name: Build Docs

diff --git a/README.md b/README.md
@@ -27,14 +27,14 @@ Online documentation is available
 ## Examples
 
 - [Basic point pattern
-    structure](https://github.com/pysal/pointpats/tree/master/notebooks/pointpattern.ipynb)
+    structure](https://github.com/pysal/pointpats/tree/main/notebooks/pointpattern.ipynb)
 - [Centrography and
-    visualization](https://github.com/pysal/pointpats/tree/master/notebooks/centrography.ipynb)
-- [Marks](https://github.com/pysal/pointpats/tree/master/notebooks/marks.ipynb)
+    visualization](https://github.com/pysal/pointpats/tree/main/notebooks/centrography.ipynb)
+- [Marks](https://github.com/pysal/pointpats/tree/main/notebooks/marks.ipynb)
 - [Simulation of point
-    processes](https://github.com/pysal/pointpats/tree/master/notebooks/process.ipynb)
+    processes](https://github.com/pysal/pointpats/tree/main/notebooks/process.ipynb)
 - [Distance based
-    statistics](https://github.com/pysal/pointpats/tree/master/notebooks/distance_statistics-numpy-oriented.ipynb)
+    statistics](https://github.com/pysal/pointpats/tree/main/notebooks/distance_statistics-numpy-oriented.ipynb)
 
 ##  Installation
 

diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
@@ -19,6 +19,15 @@ help:
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
+github:
+	@make html
+
+sync:
+	@rsync -avh _build/html/ ../docs/ --delete
+	@make clean
+	touch .nojekyll
+
 clean:
 	rm -rf $(BUILDDIR)/*
 	rm -rf auto_examples/
+	rm -rf generated/
diff --git a/doc/_static/images/G_sim_envelope.png → docs/_static/images/G_sim_envelope.png b/doc/_static/images/G_sim_envelope.png → docs/_static/images/G_sim_envelope.png
diff --git a/doc/_static/images/point_process.png → docs/_static/images/point_process.png b/doc/_static/images/point_process.png → docs/_static/images/point_process.png
diff --git a/doc/_static/images/pysal_favicon.ico → docs/_static/images/pysal_favicon.ico b/doc/_static/images/pysal_favicon.ico → docs/_static/images/pysal_favicon.ico
diff --git a/doc/_static/images/pysal_logo.png → docs/_static/images/pysal_logo.png b/doc/_static/images/pysal_logo.png → docs/_static/images/pysal_logo.png
diff --git a/doc/_static/images/quadrat.png → docs/_static/images/quadrat.png b/doc/_static/images/quadrat.png → docs/_static/images/quadrat.png
diff --git a/doc/_static/pysal-styles.css → docs/_static/pysal-styles.css b/doc/_static/pysal-styles.css → docs/_static/pysal-styles.css
diff --git a/doc/_static/references.bib → docs/_static/references.bib b/doc/_static/references.bib → docs/_static/references.bib
diff --git a/doc/api.rst → docs/api.rst b/doc/api.rst → docs/api.rst
diff --git a/doc/conf.py → docs/conf.py b/doc/conf.py → docs/conf.py
diff --git a/doc/index.rst → docs/index.rst b/doc/index.rst → docs/index.rst
@@ -18,23 +18,23 @@ for the inclusion of many newly proposed analytics for point patterns.
         <div class="col-sm-1 col-xs-hidden">
         </div>
         <div class="col-md-3 col-xs-12">
-            <a href="https://nbviewer.jupyter.org/github/pysal/pointpats/blob/master/notebooks/process.ipynb" class="thumbnail">
+            <a href="https://nbviewer.org/github/pysal/pointpats/blob/main/notebooks/process.ipynb" class="thumbnail">
                 <img src="_static/images/point_process.png" class="img-responsive center-block">
                 <div class="caption text-center">
                 <h6>Simulating point processes</h6>
                 </div>
             </a>
         </div>
         <div class="col-sm-3 col-xs-12">
-            <a href="https://nbviewer.jupyter.org/github/pysal/pointpats/blob/master/notebooks/Quadrat_statistics.ipynb" class="thumbnail">
+            <a href="https://nbviewer.org/github/pysal/pointpats/blob/main/notebooks/Quadrat_statistics.ipynb" class="thumbnail">
                 <img src="_static/images/quadrat.png" class="img-responsive center-block">
                 <div class="caption text-center">
                 <h6>Quadrat based statistics for point pattern analysis</h6>
                 </div>
             </a>
         </div>
         <div class="col-sm-3 col-xs-12">
-            <a href="https://nbviewer.jupyter.org/github/pysal/pointpats/blob/master/notebooks/distance_statistics-numpy-oriented.ipynb" class="thumbnail">
+            <a href="https://github.com/pysal/pointpats/blob/main/notebooks/distance_statistics-numpy-oriented.ipynb" class="thumbnail">
                 <img src="_static/images/G_sim_envelope.png"
                 class="img-responsive center-block">
                 <div class="caption text-center">

diff --git a/doc/installation.rst → docs/installation.rst b/doc/installation.rst → docs/installation.rst
diff --git a/doc/make.bat → docs/make.bat b/doc/make.bat → docs/make.bat
diff --git a/doc/references.rst → docs/references.rst b/doc/references.rst → docs/references.rst