Skip to content
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.

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

intersphinx issues in sunkit_instruments #51

Open
cbethge opened this issue Jan 3, 2022 · 0 comments
Open

intersphinx issues in sunkit_instruments #51

cbethge opened this issue Jan 3, 2022 · 0 comments
Labels
Bug Probably a bug. Documentation Affects the documentation.

Comments

@cbethge
Copy link
Contributor

cbethge commented Jan 3, 2022

Description

The SunPy developer newcomer's guide says that intersphinx should work with Python, Numpy, and Astropy. I am guessing that for sunkit_instruments, it should also work with SunPy, as it is an affiliated package. However, when I write the restructured text Sphinx links in my code, only Numpy links are generated correctly, Astropy and SunPy links are not.

Expected vs Actual behavior

When using Sphinx links in Python code, e.g. `~numpy.ndarray` or `~sunpy.map.Map`, the expected behavior is that the links automatically point to the correct website in the documentation.

In sunkit_instruments, this only seems to work for Numpy (`~numpy.ndarray` for example gets compiled correctly), but not for e.g. `~sunpy.map.Map` or `astropy.io.fits.header.Header`.

Steps to Reproduce

See above.

System Details

  • SunPy Version: 4.0.dev160+ga66cd925f
  • Astropy Version: 5.0
  • Python Version: 3.9.7
  • OS information: Mac OS 10.16, Arch: 64bit, (i386)
@github-actions github-actions bot removed the Bug label Nov 12, 2024
@nabobalis nabobalis added Documentation Affects the documentation. Bug Probably a bug. labels Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Probably a bug. Documentation Affects the documentation.
Projects
None yet
Development

No branches or pull requests

2 participants