Skip to content

Commit

Permalink
Merge branch 'main' into pdnagraph
Browse files Browse the repository at this point in the history
  • Loading branch information
knaaptime authored Jul 18, 2024
2 parents 9ea881e + 01d41cf commit 099bcfc
Show file tree
Hide file tree
Showing 16 changed files with 7,455 additions and 27 deletions.
21 changes: 8 additions & 13 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,18 @@ BUILDDIR = _build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

.PHONY: help Makefile generate-rst

# Custom target to generate rst files
generate-rst:
@echo "Generating custom rst files..."
@python ../scripts/w_g_comparison.py

# 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/
%: Makefile generate-rst
@$(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/
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@
"navbar_links": [
# ("Gallery", "auto_examples/index"),
("Installation", "installation"),
("Tutorial", "tutorial"),
("User Guide", "user-guide/intro"),
("API", "api"),
("References", "references"),
],
Expand Down
37 changes: 24 additions & 13 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ libpysal: Python Spatial Analysis Library Core
<div class="col-sm-1 col-xs-hidden">
</div>
<div class="col-sm-10 col-xs-12">
<a href="http://nbviewer.jupyter.org/github/pysal/libpysal/blob/main/notebooks/weights.ipynb" class="thumbnail">
<a href="http://nbviewer.jupyter.org/github/pysal/libpysal/blob/main/docs/user-guide/weights/weights.ipynb" class="thumbnail">
<img src="_static/images/npweights.png" class="img-responsive center-block">
<div class="caption text-center">
<h6>Weights for nonplanar enforced geometries</h6>
Expand All @@ -35,14 +35,24 @@ libpysal: Python Spatial Analysis Library Core
Introduction
************

**libpysal** offers four modules that form the building blocks in many upstream packages in the `PySAL family <https://pysal.org>`_:
**libpysal** offers five modules that form the building blocks in many upstream packages in the `PySAL family <https://pysal.org>`_:

- Spatial Weights: libpysal.weights
- Spatial Weights: libpysal.weights
- Spatial Graphs: libpysal.graph
- Input-and output: libpysal.io
- Computational geometry: libpysal.cg
- Built-in example datasets libpysal.examples

Examples demonstrating some of **libpysal** functionality are available in the `tutorial <tutorial.html>`_.

.. Note:: A new Graph class is being added to libpysal. For users interested in
migration from using Weights to the new Graph class, see the
`migration guide <user-guide/graph/w_g_migration.html>`_. For
developers interested in the technical details details see `W and Graph Components <migration.html>`_.



Examples demonstrating some of **libpysal** functionality are available in the
`User Guide <user-guide.html>`_.

Details are available in the `libpysal api <api.html>`_.

Expand Down Expand Up @@ -111,14 +121,15 @@ libpysal

Core components of the Python Spatial Analysis Library (`PySAL`_)

Documentation contents
----------------------
.. toctree::
:hidden:
:maxdepth: 4
:caption: Contents:

Installation <installation>
Tutorial <tutorial>
API <api>
References <references>

:maxdepth: 1

Home <self>
API reference <api>
references
user-guide/intro


.. _PySAL: https://github.com/pysal/pysal
254 changes: 254 additions & 0 deletions docs/migration.rst

Large diffs are not rendered by default.

Loading

0 comments on commit 099bcfc

Please sign in to comment.