landlab · mcflugen · Oct 10, 2022 · Oct 10, 2022 · Oct 10, 2022 · Oct 10, 2022
diff --git a/.github/workflows/black.yml b/.github/workflows/black.yml
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -0,0 +1,25 @@
+name: Check
+
+on:
+  pull_request:
+    types: [labeled, unlabeled, opened, reopened, synchronize]
+
+jobs:
+  check-changelog-entry:
+    name: changelog entry
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          # `towncrier check` runs `git diff --name-only origin/main...`, which
+          # needs a non-shallow clone.
+          fetch-depth: 0
+
+      - name: Check changelog
+        if: "!contains(github.event.pull_request.labels.*.name, 'Skip Changelog')"
+        run: |
+          if ! pipx run towncrier check --compare-with origin/${{ github.base_ref }}; then
+          echo "Please see https://landlab.readthedocs.io/en/master/development/contribution/index.html?highlight=towncrier#news-entries for guidance."
+            false
+          fi
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,38 @@
+name: Documentation
+
+on: [push, pull_request]
+
+jobs:
+    build:
+        name: Build documentation
+        # We want to run on external PRs, but not on our own internal PRs as they'll be run
+        # by the push to the branch. Without this if check, checks are duplicated since
+        # internal PRs match both the push and pull_request events.
+        if:
+          github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
+          github.repository
+
+        runs-on: ubuntu-latest
+
+        defaults:
+          run:
+            shell: bash -l {0}
+
+        steps:
+          - uses: actions/checkout@v2
+          - uses: conda-incubator/setup-miniconda@v2
+            with:
+              auto-update-conda: true
+              python-version: 3.8
+              channels: conda-forge
+              channel-priority: true
+
+          - name: Show conda installation info
+            run: |
+              conda info
+
+          - name: Install dependencies
+            run: pip install nox
+
+          - name: Build documentation
+            run: nox -s build-docs
diff --git a/.github/workflows/flake8.yml → .github/workflows/lint.yml b/.github/workflows/flake8.yml → .github/workflows/lint.yml
@@ -1,4 +1,4 @@
-name: Flake8
+name: Lint
 
 on: [push, pull_request]
 
@@ -23,5 +23,5 @@ jobs:
 
       - name: Lint
         run: |
-          pip install flake8
-          flake8 landlab_rest tests
+          pip install nox
+          nox -s lint
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -33,27 +33,16 @@ jobs:
           channels: conda-forge
           channel-priority: true
 
+
       - name: Show conda installation info
         run: |
           conda info
-          conda list
 
       - name: Install dependencies
-        run: |
-          conda install mamba -c conda-forge
-          mamba install --file=requirements.txt
-
-      - name: Build and install package
-        run: |
-          pip install -e .
-
-      - name: Install testing requirements
-        run: pip install -e .[dev]
+        run: pip install nox
 
-      - name: Test
-        run: |
-          python -c 'import landlab_rest; print(landlab_rest.__version__)'
-          pytest --cov=landlab_rest --cov-report=xml:$(pwd)/coverage.xml -vvv
+      - name: Build documentation
+        run: nox -s test
 
       - name: Coveralls
         if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.9'

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,48 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+      - id: black
+        language_version: python3.8
+
+  - repo: https://github.com/asottile/blacken-docs
+    rev: v1.12.1
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [black==21.8b0]
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        files: \.py$
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: check-builtin-literals
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: forbid-new-submodules
+      - id: trailing-whitespace
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8
+
+  - repo: https://github.com/PyCQA/pydocstyle
+    rev: 6.1.1
+    hooks:
+      - id: pydocstyle
+        files: landlab_rest/.*\.py$
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.1.0
+    hooks:
+      - id: pyupgrade
+        args: [--py38-plus]
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,26 @@
+version: 2
+
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py
+  fail_on_warning: false
+
+formats:
+  - htmlzip
+
+python:
+  # version: "3.8"
+  install:
+    - requirements: requirements-docs.txt
+    - requirements: requirements.txt
+    - method: pip
+      path: .
+  system_packages: false
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+  jobs:
+    pre_build:
+      - sphinx-apidoc -e -force --no-toc -o docs/source/api landlab_rest
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -1,15 +1,15 @@
+=======
 Credits
 =======
 
 Development Lead
 ----------------
 
-* Eric Hutton (@mcflugen)
+* `Eric Hutton <https://github.com/mcflugen>`_
 
 Contributors
 ------------
 
-* Jenny Knuth
-* Mark Piper
-* Greg Tucker
-
+* `Jenny Knuth <https://github.com/jennyknuth>`_
+* `Mark Piper <https://github.com/mdpiper>`_
+* `Greg Tucker <https://github.com/gregtucker>`_
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,5 +1,8 @@
-Changelog for landlab-rest
-==========================
+=============
+Release Notes
+=============
+
+.. towncrier-draft-entries:: Not yet released
 
 .. towncrier release notes start
 
@@ -45,5 +48,3 @@ Other Changes and Additions
 - Set up continuous integration on Travis.org. (`#5 <https://github.com/landlab/landlab-rest/issues/5>`_)
 - Added unit tests. (`#5 <https://github.com/landlab/landlab-rest/issues/5>`_)
 - Added smoke tests for the command line interface, ``start-sketchbook``. (`#7 <https://github.com/landlab/landlab-rest/issues/7>`_)
-
-
diff --git a/LICENSE.rst b/LICENSE.rst
@@ -1,7 +1,7 @@
 The MIT License (MIT)
 =====================
 
-Copyright © `2022` `Landlab`
+Copyright (c) `2022` `Eric Hutton`
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -22,4 +22,4 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
+OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.rst b/README.rst
@@ -1,3 +1,6 @@
+.. image:: https://readthedocs.org/projects/landlab-rest/badge/?version=latest
+    :target: https://landlab-rest.readthedocs.org
+
 .. image:: https://github.com/landlab/landlab-rest/actions/workflows/test.yml/badge.svg
     :target: https://github.com/landlab/landlab-rest/actions/workflows/test.yml
 
@@ -7,26 +10,65 @@
 .. image:: https://github.com/landlab/landlab-rest/actions/workflows/black.yml/badge.svg
     :target: https://github.com/landlab/landlab-rest/actions/workflows/black.yml
 
+.. image:: https://github.com/landlab/landlab-rest/actions/workflows/docs.yml/badge.svg
+    :target: https://github.com/landlab/landlab-rest/actions/workflows/docs.yml
+
 landlab REST
 ============
 
-A RESTful interface to landlab graphs.
+.. start-intro
+
+A web service for creating *Landlab* graph structures. Send
+requests to retrieve data (as json objects) that describe *Landlab*
+model grids. This includes,
+
+* *x* and *y* coordinates of a grid's nodes and corners
+* connectivity the the various grid elements
+
+Currently available grid types include :class:`~landlab.grid.raster.RasterModelGrid`,
+:class:`~landlab.grid.hex.HexModelGrid` and :class:`~landlab.grid.radial.RadialModelGrid`.
+
+.. end-intro
+
+For more information, visit `landlab-rest's documentation <https://landlab-rest.readthedocs.org>`_.
 
 Quickstart
 ----------
 
-Use `conda` to install the necessary requirements and `landlab_rest`,
+.. start-quickstart
 
-.. code::
+To get started you will need to install the *landlab-rest* package, which is currently distributed
+on `PyPI`_.
+
+1.  Install *landlab-rest* into your current environment.
+
+    .. code:: bash
 
-    $ conda install --file=requirements.txt -c conda-forge
-    $ pip install .
+        pip install landlab-rest
+
+2.  Start the server.
+
+    .. code:: bash
+
+        start-sketchbook
+
+3.  You can now send queries to the *landlab-rest* service.
+
+    .. code:: bash
+
+        curl https://0.0.0.0:8080/graphs/
+
+.. _PyPI: https://pypi.org/project/landlab-rest/
+
+.. end-quickstart
+
+.. start-running
 
 Start the server,
 
 .. code::
 
-    $ start-sketchbook
+    start-sketchbook
 
 Look at the line containing `Serving on` to see what host and port the
 server is running on. Alternatively, you can use the `--host` and `--port`
@@ -37,19 +79,19 @@ to get a `RasterModelGrid`,
 
 .. code::
 
-    $ curl https://0.0.0.0:8080/graphs/raster
+    curl https://0.0.0.0:8080/graphs/raster
 
 For a list of supported graphs
 
 .. code::
 
-    $ curl https://0.0.0.0:8080/graphs/
+    curl https://0.0.0.0:8080/graphs/
 
 You can pass parameters like,
 
 .. code::
 
-    $ curl 'https://0.0.0.0:8080/graphs/raster?shape=4,5&spacing=2.,1.'
+    curl 'https://0.0.0.0:8080/graphs/raster?shape=4,5&spacing=2.,1.'
 
 
 Docker
@@ -72,4 +114,6 @@ Once running, you can then send requests to the server. For example,
 
 .. code::
 
-    $ curl https://0.0.0.0/graphs/raster
+    curl https://0.0.0.0/graphs/raster
+
+.. end-running
diff --git a/docs/Makefile b/docs/Makefile
@@ -16,4 +16,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/source/_static/favicon.ico b/docs/source/_static/favicon.ico
diff --git a/docs/source/_static/landlab_logo.png b/docs/source/_static/landlab_logo.png
diff --git a/docs/source/_templates/links.html b/docs/source/_templates/links.html
@@ -4,4 +4,3 @@ <h3>Useful Links</h3>
   <li><a href="https://github.com/landlab//">landlab_rest @ GitHub</a></li>
   <li><a href="https://github.com/landlab/landlab_rest/issues">Issue Tracker</a></li>
 </ul>
-
diff --git a/docs/source/api/.gitignore b/docs/source/api/.gitignore
@@ -0,0 +1,2 @@
+# auto-generated with sphinx-apidoc
+landlab_*.rst
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
@@ -0,0 +1,7 @@
+landlab_rest
+============
+
+.. toctree::
+   :maxdepth: 4
+
+   landlab_rest
diff --git a/docs/source/authors.rst b/docs/source/authors.rst
@@ -0,0 +1 @@
+.. include:: ../../AUTHORS.rst
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,3 @@ <h3>Useful Links</h3>
		<li><a href="https://github.com/landlab//">landlab_rest @ GitHub</a></li>
		<li><a href="https://github.com/landlab/landlab_rest/issues">Issue Tracker</a></li>
		</ul>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# auto-generated with sphinx-apidoc
		landlab_*.rst