Skip to content

EXP: Try using sphinx.ext.apidoc instead of sphinx-automodapi #571 #572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

EXP: Try using sphinx.ext.apidoc instead of sphinx-automodapi #571 #572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2069521
Try sphinx.ext.apidoc
astrofrog Nov 5, 2025
2b1fe50
Fix API docs
astrofrog Nov 5, 2025
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
22 changes: 22 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
13 changes: 1 addition & 12 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
9 changes: 9 additions & 0 deletions reproject/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__",
]
2 changes: 2 additions & 0 deletions reproject/hips/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"]
2 changes: 2 additions & 0 deletions reproject/mosaicking/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
from .coadd import * # noqa
from .wcs_helpers import * # noqa

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