Skip to content

Commit

Permalink
add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mcara committed Dec 15, 2024
1 parent f8753d6 commit d7b124c
Show file tree
Hide file tree
Showing 5 changed files with 333 additions and 96 deletions.
10 changes: 9 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@
"gwcs": ("https://gwcs.readthedocs.io/en/latest/", None),
"astropy": ("https://docs.astropy.org/en/stable/", None),
"tweakwcs": ("https://tweakwcs.readthedocs.io/en/latest/", None),
"drizzle": (
"https://spacetelescope-drizzle.readthedocs.io/en/latest/",
None
),
}

nitpick_ignore = [("py:class", "optional"), ("py:class", "np.ndarray")]
Expand Down Expand Up @@ -75,4 +79,8 @@
html_use_index = True

# Enable nitpicky mode - which ensures that all references in the docs resolve.
nitpicky = True
nitpicky = False

nitpick_ignore = [
('py:obj', 'type'),
]
1 change: 1 addition & 0 deletions docs/stcal/package_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ Package Index
alignment/index.rst
tweakreg/index.rst
outlier_detection/index.rst
resample/index.rst
4 changes: 2 additions & 2 deletions src/stcal/resample/__init__.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
from .resample import (
Resample,
compute_wcs_pixel_area,
compute_mean_pixel_area,
UnsupportedWCSError,
)

__all__ = [
"Resample",
"compute_wcs_pixel_area",
"compute_mean_pixel_area",
"UnsupportedWCSError",
]
Loading

0 comments on commit d7b124c

Please sign in to comment.