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

Use Doxygen Awesome Theme #2050

Merged
merged 4 commits into from
Jul 3, 2023

Conversation

dgovil
Copy link
Collaborator

@dgovil dgovil commented Sep 26, 2022

This PR adds https://jothepro.github.io/doxygen-awesome-css/ to the Doxygen build. It is an MIT licensed dependency, and I vendor only the files required.

This freshens up the Doxygen theme with:

  • Responsive design so it can be viewable on mobile devices. I might be an oddball here, but I look up docs on my phone often, and the default doxygen theme is quite difficult to use.
  • Dark mode / light mode styling. The style is based on your browser/system setting but can be toggled by the icon next to the search bar. This makes the docs much more pleasant to view when everything else on my screen is dark.

Note that in the screenshots below, I have some unrelated issues building on the dev branch on my machine, which is why not everything shows up in the sidebar. I verified that was the case even with the default Doxygen setup prior to my changes. So please ignore that aspect, I'll try and resolve the unrelated build issues and then put up better screenshots as time permits. They aren't caused by these changes.

image

image

@spiffmon
Copy link
Member

Thank you, @dgovil ! Early this year we got as far as getting official legal clearance to incorporate doxygen-awesome, and have an open task for the work, but haven't been able to schedule the work, and now you've done it! Curious what version of doxygen you were using? Internally we're still on 1.8.x, and wondering if that will be problematic, given the exhortations about 1.9.x ?

@dgovil
Copy link
Collaborator Author

dgovil commented Sep 27, 2022

Ah serendipitous. I'm on doxygen 1.9.2. I don't see a prebuilt macOS build for 1.8 anywhere at the moment to try with. I can try and build from source later though given the age of Doxygen 1.8.x I never know how well that goes when building on recent macOS versions.

Though looking at their changelogs for 2.1.0 (https://github.com/jothepro/doxygen-awesome-css/releases) it seems like they still support 1.8 for the main theme and toggle.

@dgovil
Copy link
Collaborator Author

dgovil commented Sep 27, 2022

I built doxygen 1.8.20 and there don't seem to be any issues that I can see
image
image
image

@spiffmon
Copy link
Member

spiffmon commented Sep 27, 2022 via email

@tallytalwar
Copy link
Contributor

Filed as internal issue #USD-7664

@dgovil
Copy link
Collaborator Author

dgovil commented Mar 16, 2023

Hey folks, I was just wondering if there was any progress on getting this one merged? Is there anything I can do to help with that?

Browsing the default doxygen theme on mobile is very painful (and unfortunately a situation I'm often in....) so having a more mobile friendly theme like this would do wonders.

@spiffmon
Copy link
Member

spiffmon commented Mar 16, 2023 via email

@dgovil
Copy link
Collaborator Author

dgovil commented Mar 16, 2023

Ah no worries, I just wanted to check in on it.

Thank you for the update.

pixar-oss added a commit that referenced this pull request Jul 3, 2023
Use Doxygen Awesome Theme

(Internal change: 2282555)
@pixar-oss pixar-oss merged commit 9931423 into PixarAnimationStudios:dev Jul 3, 2023
@dgovil
Copy link
Collaborator Author

dgovil commented Jul 3, 2023

Awesome, thank you for merging this in :-) It's already making my day better.

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.

4 participants