Doc updates, prepare new release (#72)

* Update docs * Update env for docs * Updates for nbsphinx * Updates for nbsphinx * Updates for nbsphinx * Update header * Blacken src
TUW-GEO · Jul 20, 2021 · ed21347 · ed21347
1 parent 7f6a7f6
commit ed21347
Show file tree

Hide file tree

Showing 27 changed files with 811 additions and 935 deletions.
diff --git a/.gitignore b/.gitignore
@@ -11,7 +11,7 @@
 __pycache__/*
 .cache/*
 .*.swp
-*/.ipynb_checkpoints/*
+**/.ipynb_checkpoints/**
 .DS_Store
 
 # Project files
@@ -49,3 +49,4 @@ MANIFEST
 # Per-project virtualenvs
 .venv*/
 .artifacts/*
+_example_out/*
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,16 @@
+version: 2
+
+sphinx:
+  configuration: docs/conf.py
+
+submodules:
+  include: all
+
+conda:
+  environment: environment.yml
+
+python:
+  version: 3.8
+  install:
+    - method: pip
+      path: .
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,10 +2,11 @@
 Changelog
 =========
 
-Version x.x.x
+Version 0.4.0
 =============
 
--
+- Faster implementation of bbox search
+- Uses pyscaffold v4 standard
 
 Version 0.3.2
 =============
@@ -18,7 +19,6 @@ Version 0.3.1
 
 - Add k parameter to nearest neighbor search (number of nearest neighbors to return)
 
-
 Version 0.3.0
 =============
 

diff --git a/README.rst b/README.rst
@@ -43,12 +43,6 @@ This package should be installable through pip:
 
     pip install pygeogrids
 
-To install the package use pip 6.0 or later. On linux systems `pykdtree
-<https://github.com/storpipfugl/pykdtree>`__ will be installed whereas on
-windows systems `scipy <http://www.scipy.org/>`__ ``cKDTree`` will be used.
-pykdtree is faster than the scipy implementation but it is at the moment
-not available for Windows systems.
-
 Features
 ========
 

diff --git a/doc_requirements.txt b/doc_requirements.txt
diff --git a/docs/Creating and working with grid objects.rst b/docs/Creating and working with grid objects.rst