Skip to content

Commit

Permalink
Merge pull request #2825 from sjoro/fix-docs
Browse files Browse the repository at this point in the history
Update docs for Developer's Guide, add dev-key for dependency install…
  • Loading branch information
mraspaud authored Jul 26, 2024
2 parents 8ea1e85 + 25d09b8 commit 8b639df
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/source/dev_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ All the required dependencies for a full development environment, i.e. running t
tests and building the documentation, can be installed with::

conda install eccodes
pip install -e ".[all]"
pip install -e ".[dev]"

Running tests
=============
Expand Down Expand Up @@ -126,7 +126,7 @@ Satpy's documentation is built using Sphinx. All documentation lives in the
``doc/`` directory of the project repository. For building the documentation,
additional packages are needed. These can be installed with ::

pip install -e ".[all]"
pip install -e ".[doc]"

After editing the source files there the documentation can be generated locally::

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ tests = ["behave", "h5py", "netCDF4", "pyhdf", "imageio",
"rioxarray", "pytest", "pytest-lazy-fixtures", "defusedxml",
"s3fs", "eccodes", "h5netcdf", "xarray-datatree",
"skyfield", "ephem", "pint-xarray", "astropy", "dask-image", "python-geotiepoints", "numba"]
dev = ["satpy[doc,tests]"]

[project.scripts]
satpy_retrieve_all_aux_data = "satpy.aux_download:retrieve_all_cmd"
Expand Down

0 comments on commit 8b639df

Please sign in to comment.