Merge pull request #663 from djhoese/better-api-docs

Author: djhoese

.gitignore

@@ -65,3 +65,6 @@ pyresample/gradient/_gradient_search.c
 
 # don't include doctest files
 docs/doctest/.doctrees/*
+
+# don't include auto-generated API docs
+docs/source/api/*.rst

continuous_integration/environment.yaml

@@ -26,4 +26,5 @@ dependencies:
   - pytest-cov
   - pytest-lazy-fixtures
   - sphinx-reredirects
+  - sphinx-autodoc-typehints
   - odc-geo

docs/README.md

@@ -5,9 +5,4 @@ by running:
 
     make html
 
-The generated HTML documentation pages are available in `build/html`. If
-Pyresample's API has changed (new functions, modules, classes, etc) then the
-API documentation should be regenerated before running the above make
-command.
-
-    sphinx-apidoc -f -T -o source/api ../pyresample ../pyresample/test
+The generated HTML documentation pages are available in `build/html`.

docs/environment.yml

@@ -18,3 +18,4 @@ dependencies:
   - pykdtree
   - sphinx_rtd_theme
   - sphinx-reredirects
+  - sphinx-autodoc-typehints