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

Fix current version breaking side menu (remove bootstrap, custom css, custom js, custom template) #88

Merged
merged 10 commits into from
Jan 25, 2024

Conversation

braingram
Copy link
Contributor

@braingram braingram commented Jan 16, 2024

This PR:

  • removes the old version (2019) of bootstrap
  • removes the custom css
  • removes the empty custom javascript file
  • removes the custom template (required to include the above removed items)
  • updates a few of the rendered docutils nodes to lists, headers, etc instead of plain text to allow the above changes to have a minimal impact on the rendered docs

The above changes are mostly motivated by an issue where the old version of bootstrap causes the side/navigation menu to refuse to scroll. Making the above changes fixes this issue.

One side-effect of the above changes is the loss of the details button which collapses and expands some portions of the schema description. This seems like a reasonable loss for the benefit of not having to maintain all of the above items (which are currently causing the above described issue).

As the CI here doesn't provide previews for rendered docs I opened a test PR with asdf-standard that uses the source branch for this PR:
asdf-format/asdf-standard#418
the rendered docs for the test PR are here:
https://asdf-standard--418.org.readthedocs.build/en/418/

Here are a few useful comparisons:

For core/asdf the current docs contain the following:
Screen Shot 2024-01-16 at 2 35 36 PM
with details "expanded":
Screen Shot 2024-01-16 at 2 36 55 PM
with this PR the docs contain:
Screen Shot 2024-01-16 at 2 36 17 PM

Test PRs are also open for stdatamodels and rad:
spacetelescope/stdatamodels#246
spacetelescope/rad#354
The formatting for these is slightly different and are subject to the numerous bugs in the stsci sphinx theme.

@braingram braingram marked this pull request as ready for review January 16, 2024 19:37
@braingram braingram requested a review from eslavich January 16, 2024 19:37
@braingram braingram changed the title no bootstrap Fix current version breaking side menu (remove bootstrap, custom css, custom js, custom template) Jan 16, 2024
Copy link
Contributor

@nden nden left a comment

Choose a reason for hiding this comment

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

I think this is fine. I agree overall the benefits outweigh the loss of the details button.

@braingram
Copy link
Contributor Author

Thanks for the review!

@braingram braingram merged commit 4da23f2 into asdf-format:main Jan 25, 2024
21 of 22 checks passed
@braingram braingram deleted the no_bootstrap branch January 25, 2024 22:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants