diff --git a/.gitignore b/.gitignore index 21fe7e3ae..3970500b8 100644 --- a/.gitignore +++ b/.gitignore @@ -19,6 +19,7 @@ MANIFEST # Sphinx docs/api +docs/autoapi docs/_build # Eclipse editor project files diff --git a/docs/Makefile b/docs/Makefile index fb03f26e6..7519b4893 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -38,6 +38,7 @@ help: clean: -rm -rf $(BUILDDIR) -rm -rf api + -rm -r autoapi -rm -rf generated html: diff --git a/docs/conf.py b/docs/conf.py index e673683ed..90074e107 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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. diff --git a/docs/index.rst b/docs/index.rst index 0ddf73e2f..e84d37e17 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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: diff --git a/pyproject.toml b/pyproject.toml index a518c274b..bca83dab0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -44,6 +44,7 @@ testall = [ ] docs = [ "sphinx-astropy", + "sphinx-autoapi", "pyvo", "matplotlib", "tqdm", diff --git a/reproject/hips/__init__.py b/reproject/hips/__init__.py index ab029c63e..8d8c71859 100644 --- a/reproject/hips/__init__.py +++ b/reproject/hips/__init__.py @@ -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"] diff --git a/reproject/mosaicking/__init__.py b/reproject/mosaicking/__init__.py index 791df9b9f..51cbbefcd 100644 --- a/reproject/mosaicking/__init__.py +++ b/reproject/mosaicking/__init__.py @@ -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"]