Setup docs to build in travis with doctr (#14)

corteva · Dec 13, 2019 · e235608 · e235608
1 parent efcae58
commit e235608
Show file tree

Hide file tree

Showing 156 changed files with 35 additions and 31,796 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -2,15 +2,20 @@
 # System specifications for Travis CI
 #-------------------------------------------------------------------------------
 language: c
-os:
-  - linux
-  - osx
 env:
-  # - PYTHON_VERSION="3.5"
-  # geopandas has conflicts with python 3.5
-  - PYTHON_VERSION="3.6"
-  # - PYTHON_VERSION="3.7"
-  # datacube has dependency that is not available on python 3.7
+  global:
+    # Doctr deploy key for corteva/geocube
+    - secure: "Bdg1k0ld0Gdw5sOvL6gKRS6vQi4ICbv9OZb0uo6RgvJmbVcpNJl+D8sRCelFWUi4yVNtk3EnAVM5vIF8BtuokZsnXWH98AxWf5uTQjubgb+ycpODVNcJf+ptCA4CItY1xHSuRXzwm7EDuXh4OzXpKKlgYaa1abMUu8mJC+j6D/Uhbnv7iEDpQ7HOLYAPYVmBhflXVFrIpC2YvoZ9S7A+f6M0oiGRU+cKM1jT0O72tiq5/wLpAzpRuDRSa46Ul+soZKmjONrPqYpAuXAFIeSyluXFeJ31ghQ6ydv7n6CNAZ6pR7LIQWjQyRLd9W5TxxUuiMOfIqKeOeCIA6nGldbLUAAM1kYuNOew0SR/7ISlY2dcTU4hHgnCBQt7uCr6XY/4SNmszfyCuMyzqc1ZvM/vlPnUJX9WxeUuUEgxVNXD1y3IZADRIO7kIIo6CmCPaGEEgvf8bEOjroFYL6NR8qfjMEQ+tR1Jz0Qu5cTeTUueadrYaZmDcLOCSLI8dk+X4eSanF+Q838H8jPTdgriLWtdlqytItzVKYjDDhRF5aPk8RLZXlqEczqoO8oNl6dSeR9TU3f1glr4CEkwQoNnWE/ndax0Xqm1itgQEYW7q5lDOFY8Gp7uVCVz6Inktj+xViAdyaVydMhCG2DgF/SBuS/wivqpZarNEanrOI5NcBBmlVE="
+matrix:
+  include:
+    - os: osx
+      env:
+        - PYTHON_VERSION=3.6
+    - os: linux
+      env:
+        - PYTHON_VERSION=3.6
+        - DOC=true
+
 notifications:
   email: false
 
@@ -44,6 +49,20 @@ script:
 - py.test --cov-report term-missing --cov=geocube
 - make check
 - geocube --version
+# Building and uploading docs with doctr
+- set -e
+- |
+  if [ "$DOC" ]; then
+    sudo apt-get install -qq pandoc
+    make docs
+    pip install doctr
+    if [[ -z "$TRAVIS_TAG" ]]; then
+      DEPLOY_DIR=latest;
+    else
+      DEPLOY_DIR="$TRAVIS_TAG";
+    fi
+    doctr deploy --build-tags --built-docs docs/_build/html $DEPLOY_DIR
+  fi
 
 after_success:
   # Coveralls stats for code coverage

diff --git a/Makefile b/Makefile
@@ -70,8 +70,10 @@ test: ## run tests quickly with the default Python
 	py.test
 
 docs: ## generate Sphinx HTML documentation, including API docs
-	$(MAKE) -C sphinx clean
-	$(MAKE) -C sphinx html
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+
+docs-browser: docs ## generate Sphinx HTML documentation, including API docs
 	$(BROWSER) docs/html/index.html
 
 release: dist ## package and upload a release

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/sphinx/Makefile → docs/Makefile b/sphinx/Makefile → docs/Makefile
@@ -6,7 +6,7 @@ SPHINXOPTS    =
 SPHINXBUILD   = python -msphinx
 SPHINXPROJ    = geocube
 SOURCEDIR     = .
-BUILDDIR      = ../docs
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/sphinx/authors.rst → docs/authors.rst b/sphinx/authors.rst → docs/authors.rst
diff --git a/sphinx/cli/geocube.rst → docs/cli/geocube.rst b/sphinx/cli/geocube.rst → docs/cli/geocube.rst
diff --git a/sphinx/cli/index.rst → docs/cli/index.rst b/sphinx/cli/index.rst → docs/cli/index.rst
diff --git a/sphinx/cli/make_geocube.rst → docs/cli/make_geocube.rst b/sphinx/cli/make_geocube.rst → docs/cli/make_geocube.rst
diff --git a/sphinx/conf.py → docs/conf.py b/sphinx/conf.py → docs/conf.py
diff --git a/sphinx/contributing.rst → docs/contributing.rst b/sphinx/contributing.rst → docs/contributing.rst
diff --git a/sphinx/examples/categorical.ipynb → docs/examples/categorical.ipynb b/sphinx/examples/categorical.ipynb → docs/examples/categorical.ipynb
diff --git a/sphinx/examples/examples.rst → docs/examples/examples.rst b/sphinx/examples/examples.rst → docs/examples/examples.rst
diff --git a/sphinx/examples/grid_to_vector_map.ipynb → docs/examples/grid_to_vector_map.ipynb b/sphinx/examples/grid_to_vector_map.ipynb → docs/examples/grid_to_vector_map.ipynb
diff --git a/sphinx/examples/resample_point_data.ipynb → docs/examples/resample_point_data.ipynb b/sphinx/examples/resample_point_data.ipynb → docs/examples/resample_point_data.ipynb
diff --git a/sphinx/examples/timestamp_missing_data.ipynb → docs/examples/timestamp_missing_data.ipynb b/sphinx/examples/timestamp_missing_data.ipynb → docs/examples/timestamp_missing_data.ipynb
diff --git a/sphinx/examples/zonal_statistics.ipynb → docs/examples/zonal_statistics.ipynb b/sphinx/examples/zonal_statistics.ipynb → docs/examples/zonal_statistics.ipynb
diff --git a/sphinx/geocube.api.rst → docs/geocube.api.rst b/sphinx/geocube.api.rst → docs/geocube.api.rst
diff --git a/sphinx/geocube.geo_utils.rst → docs/geocube.geo_utils.rst b/sphinx/geocube.geo_utils.rst → docs/geocube.geo_utils.rst
diff --git a/sphinx/geocube.rst → docs/geocube.rst b/sphinx/geocube.rst → docs/geocube.rst
diff --git a/sphinx/geocube.xarray_extensions.rst → docs/geocube.xarray_extensions.rst b/sphinx/geocube.xarray_extensions.rst → docs/geocube.xarray_extensions.rst
diff --git a/sphinx/history.rst → docs/history.rst b/sphinx/history.rst → docs/history.rst
diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo
diff --git a/docs/html/_images/examples_categorical_13_1.png b/docs/html/_images/examples_categorical_13_1.png
diff --git a/docs/html/_images/examples_categorical_16_1.png b/docs/html/_images/examples_categorical_16_1.png
diff --git a/docs/html/_images/examples_categorical_4_1.png b/docs/html/_images/examples_categorical_4_1.png
diff --git a/docs/html/_images/examples_resample_point_data_10_1.png b/docs/html/_images/examples_resample_point_data_10_1.png
diff --git a/docs/html/_images/examples_resample_point_data_14_1.png b/docs/html/_images/examples_resample_point_data_14_1.png
diff --git a/docs/html/_images/examples_resample_point_data_5_1.png b/docs/html/_images/examples_resample_point_data_5_1.png
diff --git a/docs/html/_images/examples_timestamp_missing_data_12_1.png b/docs/html/_images/examples_timestamp_missing_data_12_1.png
diff --git a/docs/html/_images/examples_timestamp_missing_data_15_1.png b/docs/html/_images/examples_timestamp_missing_data_15_1.png
diff --git a/docs/html/_images/examples_timestamp_missing_data_18_1.png b/docs/html/_images/examples_timestamp_missing_data_18_1.png
diff --git a/docs/html/_images/examples_timestamp_missing_data_9_1.png b/docs/html/_images/examples_timestamp_missing_data_9_1.png
diff --git a/docs/html/_modules/geocube/api/core.html b/docs/html/_modules/geocube/api/core.html