diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000000..1da3abe673 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,12 @@ +# 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 + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +conda: + environment: doc/rtd_environment.yml diff --git a/doc/rtd_environment.yml b/doc/rtd_environment.yml new file mode 100644 index 0000000000..97c32d49b6 --- /dev/null +++ b/doc/rtd_environment.yml @@ -0,0 +1,22 @@ +name: readthedocs +channels: + - conda-forge +dependencies: + - python=3.7 + - pip + - dask + - graphviz + - numpy + - pillow + - pyresample + - setuptools + - setuptools_scm + - setuptools_scm_git_archive + - sphinx + - sphinx_rtd_theme + - trollsift + - xarray + - zarr + - pip: + - graphviz + - .. # relative path to the satpy project diff --git a/doc/source/conf.py b/doc/source/conf.py index cdfae3cbd6..ce28c35a5a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -69,7 +69,10 @@ def __getattr__(cls, name): for mod_name in MOCK_MODULES: sys.modules[mod_name] = Mock() -autodoc_mock_imports = ['h5netcdf', 'pyninjotiff', 'pygac', 'cf', 'glymur', 'pyhdf', 'osgeo', 'mipp'] +autodoc_mock_imports = ['cf', 'glymur', 'h5netcdf', 'imageio', 'mipp', 'netCDF4', + 'pygac', 'pygrib', 'pyhdf', 'pyninjotiff', + 'pyorbital', 'pyspectral', 'rasterio', 'trollimage', + 'zarr'] autoclass_content = 'both' # append class __init__ docstring to the class docstring # -- General configuration -----------------------------------------------------