-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Fix #11366 #11622
Fix #11366 #11622
Conversation
In the dev docs themselves it is still necessary to use some templating in order to *not* use these links, unless I am missing a way to provide a dummy intersphinx mapping.
I just realized there are some other "if is_development" sections in install.rst that were added since I last worked on this. So I'll go back to using the Jinja templating just for those sections for now, and worry about reworking those parts as part of #11621 |
appropriately whether or not building the dev docs: * For dev docs it resolves to the local documentation (this includes when reading a local copy of the docs, e.g. when testing the docs during development) * For stable docs it will use the intersphinx mapping for astropy-dev. This obviates the need for the Jinja templating in most cases.
|
p.s. Saw your pings for reviews. It is on my todo list! |
Huh, why would it? |
@Cadair , because @embray , if you feel strongly about adding back "Affects-dev" for the change log check, I can add that logic into https://github.com/pllim/actions-towncrier-changelog but the change will likely be lost when/if we switch back to using https://github.com/OpenAstronomy/baldrick/blob/master/baldrick/plugins/github_towncrier_changelog.py . For now, only |
What did it do?! |
Full logic is here, but it probably won't apply as-is with new change log system: https://github.com/astropy/astropy-bot/blob/main/astropy_bot/changelog_checker.py |
Co-authored-by: Erik M. Bray <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks fine, except for a minor typo.
I am testing the "stable" build at #11652
And for my own future reference, in this PR, https://astropy--11622.org.readthedocs.build/en/11622/install.html resolved the link for "virtualenv" to https://astropy--11622.org.readthedocs.build/en/11622/development/workflow/virtual_pythons.html#virtual-envs , as expected. |
Co-authored-by: Erik M. Bray <[email protected]>
@pllim Fixed! Thanks for the confirm. |
[ci skip]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. It's like magic. Thanks!
Co-authored-by: Erik M. Bray <[email protected]>
This fixes #11366 by adding two things:
Adds
astropy-dev
to the intersphinx mappings. This can be used now anywhere in the Astropy docs to link to docs in thecurrent development version (but particularly this is useful for linking to the Developer Guide since it now lives only in the
development version).
When building the development version of the docs,
astropy-dev:
references are automatically resolved in the "normal" manneras though the
astropy-dev:
prefix weren't there, so it avoids using the intersphinx mapping in this case.