diff --git a/docs/conf.py b/docs/conf.py index e673683ed..bf48a4723 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,6 +10,28 @@ print("ERROR: the documentation requires the sphinx-astropy package to be installed") sys.exit(1) +extensions.append("sphinx.ext.apidoc") + +extensions.remove("sphinx_automodapi.automodapi") +extensions.remove("sphinx_automodapi.smart_resolver") + +apidoc_modules = [ + { + "path": "../reproject", + "destination": "api/", + "exclude_patterns": ["**/tests/**", "**/conftest.py", "**/*version.py"], + "max_depth": 1, + "follow_links": False, + "separate_modules": False, + "include_private": False, + "no_headings": False, + "module_first": False, + "implicit_namespaces": False, + "automodule_options": {"members", "show-inheritance", "undoc-members", "imported-members"}, + }, +] + + # -- General configuration ---------------------------------------------------- # By default, highlight as Python 3. diff --git a/docs/index.rst b/docs/index.rst index 0ddf73e2f..1568ce1e5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -156,15 +156,4 @@ 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: + api/modules diff --git a/reproject/__init__.py b/reproject/__init__.py index 85e446232..eb8c7607c 100644 --- a/reproject/__init__.py +++ b/reproject/__init__.py @@ -7,3 +7,12 @@ from .interpolation import reproject_interp # noqa from .spherical_intersect import reproject_exact # noqa from .version import __version__ # noqa + +__all__ = [ + "reproject_adaptive", + "reproject_from_healpix", + "reproject_to_healpix", + "reproject_interp", + "reproject_exact", + "__version__", +] diff --git a/reproject/hips/__init__.py b/reproject/hips/__init__.py index ab029c63e..472a2005b 100644 --- a/reproject/hips/__init__.py +++ b/reproject/hips/__init__.py @@ -1,2 +1,4 @@ from .high_level import * # noqa from ._dask_array import hips_as_dask_array # noqa + +__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..695f15aca 100644 --- a/reproject/mosaicking/__init__.py +++ b/reproject/mosaicking/__init__.py @@ -1,2 +1,4 @@ from .coadd import * # noqa from .wcs_helpers import * # noqa + +__all__ = ["reproject_and_coadd", "find_optimal_celestial_wcs"]