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

Update dependencies to newest version #100

Closed
mb-emag opened this issue Apr 14, 2023 · 5 comments · Fixed by #133
Closed

Update dependencies to newest version #100

mb-emag opened this issue Apr 14, 2023 · 5 comments · Fixed by #133

Comments

@mb-emag
Copy link
Contributor

mb-emag commented Apr 14, 2023

Right now we still use Sphinx 4.5 - mainly because the theme we're using (sphinx-books) wasn't compatible with newer sphinx releases last time we checked (been some time)...

Meanwhile sphinx-books got a big update so we can update, however on a quick first look this created some issues:

  • styling is broken
    • this needs some css fixes.
    • there is now a dark mode which is completely unsupported by us right now (need to check if this could be combined with doxygen awesome dark mode)
    • btw. we should also update doxygen awesome
    • as we're also supporting rtd-theme we should also check it's behavior...

All this might be a breaking change for existing doxysphinx users, therefore we should consider doing a major version bump on this one.

@Maetveis
Copy link
Contributor

  • there is now a dark mode which is completely unsupported by us right now (need to check if this could be combined with doxygen awesome dark mode)

I can chime in here: it can be done. I have done this for the upcoming ROCm documentation, by slightly editing doxygen-awesome. You can see it here: https://advanced-micro-devices-rocm-docs-core.readthedocs-hosted.com/en/latest/demo/doxygen/html/example_8hpp.html. I would gladly help to clean this up a little and upstream it.

@mb-emag
Copy link
Contributor Author

mb-emag commented Apr 20, 2023

Hi @Maetveis,

that looks totally awesome sir! We would really like to have this! 😀

@twodrops
Copy link
Collaborator

twodrops commented May 2, 2024

The above hosting seems to have moved. I found it here again
https://rocm.docs.amd.com/projects/rocAL/en/latest/doxygen/html/group__group__rocal.html
(not the demo above however, but doxysphinx usage)

@twodrops
Copy link
Collaborator

twodrops commented May 2, 2024

@Maetveis Do you still have the time to contribute this upstream? It would be really great! See related PR here.

@Maetveis
Copy link
Contributor

Maetveis commented May 5, 2024

@Maetveis Do you still have the time to contribute this upstream? It would be really great! See related PR here.

I will probably have time next weekend, until that I will summarize what I did on the PR, if someone wants to do it.

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 a pull request may close this issue.

3 participants