Add python3 kernel for doc build (#138)

* Add python3 kernel for doc build

* Remove Waterwatch from doc

* Package for Python 3.12

Author: thodson-usgs

.github/workflows/python-package.yml

@@ -5,7 +5,9 @@ name: Python package
 
 on:
   push:
+    branches: ['master']
   pull_request:
+    branches: ['master']
 
 jobs:
   build:
@@ -14,7 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: [3.8, 3.9, '3.10', 3.11]
+        python-version: [3.8, 3.9, '3.10', 3.11, 3.12]
 
     steps:
       - uses: actions/checkout@v2

.github/workflows/sphinx-docs.yml

@@ -19,6 +19,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install .[doc]
+          ipython kernel install --name "python3" --user
           sudo apt update -y && sudo apt install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended dvipng pandoc
           (cd docs && make docs)
           (cd docs && make html)

docs/source/conf.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -32,7 +30,7 @@
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
     'nbsphinx',
-    'nbsphinx_link'
+    'nbsphinx_link',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -85,7 +83,7 @@
 autodoc_default_options = {
     'members': True,
     'inherited-members': False,
-    'private-members': True
+    'private-members': True,
 }
 
 # doctest
@@ -108,8 +106,8 @@
 # documentation.
 
 html_theme_options = {
-    "logo_only": False,
-    "display_version": True,
+    'logo_only': False,
+    'display_version': True,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -124,5 +122,8 @@
     r'https://streamstats.usgs.gov/streamstatsservices/#/',
     r'https://www.waterqualitydata.us/public_srsnames/',
     r'https://waterqualitydata.us',
-    r'https://github.com/USGS-python/dataretrieval/tree/master/demos/hydroshare'
+    r'https://github.com/USGS-python/dataretrieval/tree/master/demos/hydroshare',
 ]
+
+# Some notebooks have warnings, which nbsphinx should ignore
+nbsphinx_allow_errors = True

docs/source/reference/index.rst

@@ -11,5 +11,4 @@ API reference
     nwis
     streamstats
     utils
-    waterwatch
-    wqp
+    wqp

docs/source/reference/waterwatch.rst

@@ -21,7 +21,5 @@ provided below.
 +-----------------------------------+---------------------------------------------------------------+
 | Water Quality Portal              | https://waterqualitydata.us                                   |
 +-----------------------------------+---------------------------------------------------------------+
-| WaterWatch                        | https://waterwatch.usgs.gov                                   |
-+-----------------------------------+---------------------------------------------------------------+
 | Water Services                    | https://waterservices.usgs.gov                                |
-+-----------------------------------+---------------------------------------------------------------+
++-----------------------------------+---------------------------------------------------------------+

docs/source/userguide/dataportals.rst

@@ -34,9 +34,12 @@ test = [
 ]
 doc = [
   "sphinx",
-  "sphinx_rtd_theme",
+  "sphinx-rtd-theme",
   "nbsphinx",
   "nbsphinx_link",
+  "ipython",
+  "ipykernel",
+  "matplotlib",
 ]
 nldi = [
   'geopandas>=0.10'