Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to configuration file for readthedocs #1025

Merged
merged 3 commits into from
Dec 18, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -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
22 changes: 22 additions & 0 deletions doc/rtd_environment.yml
Original file line number Diff line number Diff line change
@@ -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
5 changes: 4 additions & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 -----------------------------------------------------
Expand Down