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

Adding version information to the landing page #8642

Merged
merged 2 commits into from
Jul 12, 2024

Conversation

jhunkeler
Copy link
Collaborator

@jhunkeler jhunkeler commented Jul 12, 2024

Resolves JP-3549

See #8299 #8633

Removing the stable branch and allowing RTD to build its own stable documentation has one drawback: the release version (visible under the STScI logo) is replaced with "stable". The release information is written to the HTML <title>...</title> tag, so it is technically visible to the user, but only barely.

This PR displays the release version on the index page. When the stable documentation is generated it will continue to write "stable" below the logo above the navigation pane, however, the user will not need to hunt through the page's source code to find the actual version the documentation relates to.

Demo: https://jwst-pipeline--8642.org.readthedocs.build/en/8642/

Checklist for PR authors (skip items if you don't have permissions or they are not applicable)

  • added entry in CHANGES.rst within the relevant release section
  • updated or added relevant tests
  • updated relevant documentation
  • added relevant milestone
  • added relevant label(s)
  • ran regression tests, post a link to the Jenkins job below.
    How to run regression tests on a PR
  • All comments are resolved
  • Make sure the JIRA ticket is resolved properly

@jhunkeler jhunkeler requested a review from a team as a code owner July 12, 2024 15:46
@nden nden merged commit bc8099e into spacetelescope:master Jul 12, 2024
17 of 19 checks passed
@nden nden added this to the Build 11.1 milestone Jul 20, 2024
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