Skip to content

Add substitutions to credits.rst for astropy.org site#19192

Merged
pllim merged 2 commits intoastropy:mainfrom
Cadair:credits-subs
Jan 20, 2026
Merged

Add substitutions to credits.rst for astropy.org site#19192
pllim merged 2 commits intoastropy:mainfrom
Cadair:credits-subs

Conversation

@Cadair
Copy link
Member

@Cadair Cadair commented Jan 20, 2026


Description

In rewriting astropy.org to use sphinx I need this to fix some errors.

xref astropy/astropy.github.com#698

  • By checking this box, the PR author has requested that maintainers do NOT use the "Squash and Merge" button. Maintainers should respect this when possible; however, the final decision is at the discretion of the maintainer that merges the PR.

@github-actions github-actions bot added the Docs label Jan 20, 2026
@github-actions
Copy link
Contributor

Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.

  • Do the proposed changes actually accomplish desired goals?
  • Do the proposed changes follow the Astropy coding guidelines?
  • Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
  • Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
  • Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see instructions for rebase and squash.
  • Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
  • Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
  • Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
  • At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

docs/credits.rst Outdated

For how to acknowledge Astropy, please see `the Acknowledging or Citing Astropy page <https://www.astropy.org/acknowledging.html>`_.

.. These substitutions are duplicated here so this rst file can be used in the astropy.org site without triggering warnings.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But is this directive actually used in the doc build of this repo somewhere?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes they are in conf.py but the website can't read that.

This comment was marked as outdated.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then do we have to delete this? Now we have duplicate here

astropy/docs/conf.py

Lines 533 to 535 in cb7e56a

# Astropy
"Astropy mailing list": "https://mail.python.org/mailman/listinfo/astropy",
"astropy-dev mailing list": "https://groups.google.com/group/astropy-dev",

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No they might be used in other places in the docs

This comment was marked as duplicate.

This comment was marked as duplicate.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then should we add extra comment to remind ourselves to keep in sync with conf.py?

@pllim
Copy link
Member

pllim commented Jan 20, 2026

Does this need backport?

@pllim pllim added this to the v8.0.0 milestone Jan 20, 2026
@Cadair
Copy link
Member Author

Cadair commented Jan 20, 2026

Does this need backport?

No

@pllim
Copy link
Member

pllim commented Jan 20, 2026

p.s. Rebase to get green RTD pls

Copy link
Member

@pllim pllim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good luck!

@pllim pllim enabled auto-merge (squash) January 20, 2026 19:02
@pllim pllim merged commit 96a77c5 into astropy:main Jan 20, 2026
33 of 34 checks passed
@Cadair Cadair deleted the credits-subs branch January 20, 2026 20:40
Perikliscode pushed a commit to Perikliscode/astropy_PeriklisFork that referenced this pull request Jan 21, 2026
* Add substitutions to credits.rst for astropy.org site
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants