Skip to content

Fix API documentation missing #560

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

Merged
Jan-Willem merged 3 commits into from
Mar 31, 2026
Merged

Fix API documentation missing #560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f8226c
update casacore extra req for pip, #559
FedeMPouzols Mar 27, 2026
53a838d
nitpicky-ignore many warnings about optional, #559
FedeMPouzols Mar 27, 2026
2aba15d
fix conf.py formatting, #559
FedeMPouzols Mar 27, 2026
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
2 changes: 1 addition & 1 deletion .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ python:
- method: pip
path: .
extra_requirements:
- python-casacore
- casacore

# Configuration for Sphinx documentation
sphinx:
Expand Down
5 changes: 5 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,11 @@

nitpicky = True

# Ignore nitpicky warnings related to Python built-ins and the like
# (https://stackoverflow.com/questions/11417221/sphinx-autodoc-gives-warning-pyclass-reference-target-not-found-type-warning)
# (https://bugs.python.org/issue11975)
nitpick_ignore = [("py:class", "optional")]

intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"astropy": ("https://docs.astropy.org/en/stable", None),
Expand Down
Loading