Merge pull request #110 from sfinkens/rtd-api

Add conda environment for readthedocs

Author: sfinkens

.readthedocs.yml

@@ -0,0 +1,14 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/source/conf.py
+  fail_on_warning: true
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "mambaforge-4.10"
+conda:
+  environment: doc/rtd_environment.yml

doc/rtd_environment.yaml

@@ -0,0 +1,27 @@
+name: readthedocs
+channels:
+  - conda-forge
+dependencies:
+  - python=3.9
+  - numpy
+  - scipy
+  - bottleneck
+  - python-dateutil
+  - hdf5
+  - h5py
+  - graphviz
+  - setuptools
+  - setuptools_scm
+  - setuptools_scm_git_archive
+  - sphinx
+  - sphinx_rtd_theme
+  - sphinxcontrib-apidoc
+  - pip
+  - pip:
+    - docutils
+    - pyorbital
+    - python-geotiepoints
+    - trollimage
+    - pyspectral
+    - pyorbital
+    - ..  # relative path to the pygac project

doc/source/_static/.gitkeep

@@ -156,9 +156,11 @@ def __new__(cls, spacecraft, custom_coeffs=None, coeffs_file=None):
     @classmethod
     def read_coeffs(cls, coeffs_file):
         """Read calibration coefficients for all satellites from file.
-        Argument
+
+        Args:
             coeffs_file (str): path to coefficients file
-        Returns
+
+        Returns:
             coeffs (dict): dictionary containing coefficients for all satellites
             version (str): version of the coefficients (None if unknown)
         """