Skip to content
Draft
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ MANIFEST

# Sphinx
docs/api
docs/autoapi
docs/_build

# Eclipse editor project files
Expand Down
1 change: 1 addition & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ help:
clean:
-rm -rf $(BUILDDIR)
-rm -rf api
-rm -r autoapi
-rm -rf generated

html:
Expand Down
16 changes: 16 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,22 @@
print("ERROR: the documentation requires the sphinx-astropy package to be installed")
sys.exit(1)

extensions.append("sphinx.ext.autodoc")
extensions.append("autoapi.extension")

autoapi_dirs = ["../reproject"]
autoapi_options = [
"members",
"imported-members",
"inherited-members",
"show-inheritance",
"undoc-members",
]
autoapi_own_page_level = "function"
autoapi_ignore = ["**/tests/**", "**/tests/", "**/conftest.py", "**/version.py"]

suppress_warnings.append("autoapi.python_import_resolution")

# -- General configuration ----------------------------------------------------

# By default, highlight as Python 3.
Expand Down
12 changes: 0 additions & 12 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,15 +156,3 @@ that you want to reproject.
mosaicking
performance
performance_mosaicking

Reference/API
=============

.. automodapi:: reproject
:no-inheritance-diagram:

.. automodapi:: reproject.hips
:no-inheritance-diagram:

.. automodapi:: reproject.mosaicking
:no-inheritance-diagram:
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ testall = [
]
docs = [
"sphinx-astropy",
"sphinx-autoapi",
"pyvo",
"matplotlib",
"tqdm",
Expand Down
10 changes: 8 additions & 2 deletions reproject/hips/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
from .high_level import * # noqa
from ._dask_array import hips_as_dask_array # noqa
from ._dask_array import hips_as_dask_array
from .high_level import (
coadd_hips,
reproject_from_hips,
reproject_to_hips,
)

__all__ = ["reproject_from_hips", "reproject_to_hips", "coadd_hips", "hips_as_dask_array"]
6 changes: 4 additions & 2 deletions reproject/mosaicking/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
from .coadd import * # noqa
from .wcs_helpers import * # noqa
from .coadd import reproject_and_coadd
from .wcs_helpers import find_optimal_celestial_wcs

__all__ = ["reproject_and_coadd", "find_optimal_celestial_wcs"]
Loading