Add documentation

.github/workflows/sphinx.yaml

@@ -0,0 +1,33 @@
+name: sphinx
+on:
+  push:
+    branches:
+    - main
+    paths:
+    - 'docs/**'
+    - '**.py'
+    - 'requirements.txt'
+    - '.github/workflows/sphinx.yaml'
+  pull_request:
+    branches:
+    - main
+    paths:
+    - 'docs/**'
+    - '**.py'
+    - 'requirements.txt'
+    - '.github/workflows/sphinx.yaml'
+jobs:
+  sphinx:
+    name: sphinx
+    runs-on: ubuntu-latest
+    steps:
+    - name: Clone repo
+      uses: actions/checkout@v2
+    - name: Set up python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+    - name: Install dependencies
+      run: pip3 install -r requirements.txt
+    - name: Run sphinx checks
+      run: cd docs && make html

README.md

@@ -4,6 +4,7 @@ PyTorch data loaders for geospatial data
 [![flake8](https://github.com/microsoft/torchgeo/workflows/flake8/badge.svg)](https://github.com/microsoft/torchgeo/actions)
 [![black](https://github.com/microsoft/torchgeo/workflows/black/badge.svg)](https://github.com/microsoft/torchgeo/actions)
 [![mypy](https://github.com/microsoft/torchgeo/workflows/mypy/badge.svg)](https://github.com/microsoft/torchgeo/actions)
+[![sphinx](https://github.com/microsoft/torchgeo/workflows/sphinx/badge.svg)](https://github.com/microsoft/torchgeo/actions)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 ## Contributing

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?= -W
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# 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)

docs/conf.py

@@ -0,0 +1,62 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# 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.
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "torchgeo"
+copyright = "2021, Microsoft Corporation"
+author = "Adam J. Stewart"
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "pytorch_sphinx_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+
+# -- Extension configuration -------------------------------------------------
+
+autodoc_default_options = {
+    "special-members": "__call__, __getitem__, __init__, __len__"
+}
+
+autodoc_member_order = "bysource"
+
+autodoc_typehints = "description"

docs/index.rst

@@ -0,0 +1,22 @@
+.. torchgeo documentation master file, created by
+   sphinx-quickstart on Tue Jun 15 20:21:46 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to torchgeo's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   torchgeo
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/torchgeo.datasets.rst

@@ -0,0 +1,61 @@
+torchgeo.datasets package
+=========================
+
+Submodules
+----------
+
+torchgeo.datasets.cowc module
+-----------------------------
+
+.. automodule:: torchgeo.datasets.cowc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+torchgeo.datasets.cv4a\_kenya\_crop\_type module
+------------------------------------------------
+
+.. automodule:: torchgeo.datasets.cv4a_kenya_crop_type
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+torchgeo.datasets.geo module
+----------------------------
+
+.. automodule:: torchgeo.datasets.geo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+torchgeo.datasets.landcoverai module
+------------------------------------
+
+.. automodule:: torchgeo.datasets.landcoverai
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+torchgeo.datasets.nwpu module
+-----------------------------
+
+.. automodule:: torchgeo.datasets.nwpu
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+torchgeo.datasets.utils module
+------------------------------
+
+.. automodule:: torchgeo.datasets.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: torchgeo.datasets
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/torchgeo.rst

@@ -0,0 +1,19 @@
+torchgeo package
+================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   torchgeo.datasets
+   torchgeo.transforms
+
+Module contents
+---------------
+
+.. automodule:: torchgeo
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/torchgeo.transforms.rst

@@ -0,0 +1,21 @@
+torchgeo.transforms package
+===========================
+
+Submodules
+----------
+
+torchgeo.transforms.transforms module
+-------------------------------------
+
+.. automodule:: torchgeo.transforms.transforms
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: torchgeo.transforms
+   :members:
+   :undoc-members:
+   :show-inheritance:

requirements.txt

@@ -3,9 +3,11 @@ flake8
 flake8-import-order
 mypy
 opencv-python
-Pillow
+pillow
 pycocotools
+pytorch-sphinx-theme
 radiant-mlhub>=0.2.1
 rarfile
+sphinx
 torch
 torchvision

setup.py

@@ -3,4 +3,5 @@
 import setuptools
 
 
-setuptools.setup()
+if __name__ == "__main__":
+    setuptools.setup()

spack.yaml

@@ -8,8 +8,10 @@ spack:
   - py-mypy
   - py-pillow-simd
   - py-pycocotools
+  - py-pytorch-sphinx-theme
   - "py-radiant-mlhub@0.2.1:"
   - py-rarfile
+  - py-sphinx
   - py-torch
   - py-torchvision
   concretization: together

torchgeo/datasets/landcoverai.py

@@ -13,23 +13,20 @@ class LandCoverAI(VisionDataset):
     dataset is a dataset for automatic mapping of buildings, woodlands, water and
     roads from aerial images.
 
-    Dataset features
-    ~~~~~~~~~~~~~~~~
+    Dataset features:
 
     * land cover from Poland, Central Europe
     * three spectral bands - RGB
     * 33 orthophotos with 25 cm per pixel resolution (~9000x9500 px)
     * 8 orthophotos with 50 cm per pixel resolution (~4200x4700 px)
     * total area of 216.27 km:sup:`2`
 
-    Dataset format
-    ~~~~~~~~~~~~~~
+    Dataset format:
 
     * rasters are three-channel GeoTiffs with EPSG:2180 spatial reference system
     * masks are single-channel GeoTiffs with EPSG:2180 spatial reference system
 
-    Dataset classes
-    ~~~~~~~~~~~~~~~
+    Dataset classes:
 
     1. building (1.85 km:sup:`2`)
     2. woodland (72.02 km:sup:`2`)

torchgeo/datasets/nwpu.py

@@ -22,8 +22,8 @@ class VHR10(VisionDataset):
 
     The data set is divided into two sets:
 
-    *. Positive image set (650 images) which contains at least one target in an image
-    *. Negative image set (150 images) does not contain any targets
+    * Positive image set (650 images) which contains at least one target in an image
+    * Negative image set (150 images) does not contain any targets
 
     The positive image set consists of objects from ten classes: