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

Fixes sphinx tabs to make them work in dark theme #584

Merged
merged 12 commits into from
Jun 27, 2024
Merged

Conversation

Mayankm96
Copy link
Contributor

@Mayankm96 Mayankm96 commented Jun 27, 2024

Description

Earlier, we used the sphinx-tabs module, which didn't work well with the sphinx-book-theme of our documentation. This MR removes this dependency and uses sphinx-design instead for tabs. This natively supports the dark theme.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update

Screenshots

dark-theme.mp4

Checklist

  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have run all the tests with ./isaaclab.sh --test and they pass
  • I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@Dhoeller19 Dhoeller19 self-requested a review June 27, 2024 12:22
@Mayankm96 Mayankm96 self-assigned this Jun 27, 2024
@Mayankm96 Mayankm96 added bug Something isn't working documentation Improvements or additions to documentation labels Jun 27, 2024
@Mayankm96 Mayankm96 changed the title Fixes Sphinx tabs to make them work in dark theme Fixes sphinx tabs to make them work in dark theme Jun 27, 2024
@Dhoeller19 Dhoeller19 merged commit aef99e4 into main Jun 27, 2024
2 of 3 checks passed
@Dhoeller19 Dhoeller19 deleted the fix/dark-theme branch June 27, 2024 12:50
fatimaanes pushed a commit to fatimaanes/omniperf that referenced this pull request Aug 8, 2024
Earlier, we used the `sphinx-tabs` module, which didn't work well with
the `sphinx-book-theme` of our documentation. This MR removes this
dependency and uses `sphinx-design` instead for tabs. This natively
supports the dark theme.

## Type of change

- Bug fix (non-breaking change which fixes an issue)
- This change requires a documentation update

## Screenshots


https://github.com/isaac-sim/IsaacLab/assets/12863862/a56e1fa4-9b3c-4161-83bd-95b0e3b10334


## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have run all the tests with `./isaaclab.sh --test` and they pass
- [x] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
iamdrfly pushed a commit to iamdrfly/IsaacLab that referenced this pull request Nov 21, 2024
Earlier, we used the `sphinx-tabs` module, which didn't work well with
the `sphinx-book-theme` of our documentation. This MR removes this
dependency and uses `sphinx-design` instead for tabs. This natively
supports the dark theme.

## Type of change

- Bug fix (non-breaking change which fixes an issue)
- This change requires a documentation update

## Screenshots


https://github.com/isaac-sim/IsaacLab/assets/12863862/a56e1fa4-9b3c-4161-83bd-95b0e3b10334


## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have run all the tests with `./isaaclab.sh --test` and they pass
- [x] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants