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

docs link cleanup #3095

Merged
merged 3 commits into from
Jul 18, 2024
Merged

docs link cleanup #3095

merged 3 commits into from
Jul 18, 2024

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented Jul 17, 2024

Description

This pull request cleans up some logic in generating docs links from plugins and now includes the version tag for the help button in the top app bar for the default app (does not change anything when a config exists).

Found these while investigating the solution for spacetelescope/lcviz#128, but is not required for the downstream implementation.

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

rather than repeating logic
(only applies when no config is detected)
@kecnry kecnry added trivial Only needs one approval instead of two no-changelog-entry-needed changelog bot directive labels Jul 17, 2024
@kecnry kecnry added this to the 4.0 milestone Jul 17, 2024
Copy link

codecov bot commented Jul 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.73%. Comparing base (23b3edd) to head (8475a9c).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3095      +/-   ##
==========================================
- Coverage   88.73%   88.73%   -0.01%     
==========================================
  Files         111      111              
  Lines       17262    17261       -1     
==========================================
- Hits        15317    15316       -1     
  Misses       1945     1945              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@bmorris3 bmorris3 left a comment

Choose a reason for hiding this comment

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

Tested, it works. 👌🏻

@kecnry kecnry merged commit f35af23 into spacetelescope:main Jul 18, 2024
18 of 19 checks passed
@kecnry kecnry deleted the docs-link-cleanup branch July 18, 2024 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog-entry-needed changelog bot directive trivial Only needs one approval instead of two
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants