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

consider removing cppkokkos domain #559

Open
nmm0 opened this issue Jul 31, 2024 · 3 comments
Open

consider removing cppkokkos domain #559

nmm0 opened this issue Jul 31, 2024 · 3 comments

Comments

@nmm0
Copy link
Contributor

nmm0 commented Jul 31, 2024

Currently we have forked the the sphinx cpp domain in a domain called cppkokkos. The idea is we wanted some specific markup for deprecated types and functions. However, we currently have a PR #451 that no one can work on for updating it to sync it with the latest sphinx release. This represents a maintenance burden for us, and will continue to cause problems in the future.

Furthermore, we can render deprecated code markings fine via C++ annotation syntax:
deprecated_doc_kokkos

If this is sufficient to render (and we could hack the CSS if we wanted to change how it looked), we could entirely drop cppkokkos and reduce our maintenance burden.

Are there any other reasons why we should keep the cppkokkos domain? @fnrizzi

@fnrizzi
Copy link
Collaborator

fnrizzi commented Jul 31, 2024

There was also the use of cppkokkos to define Kokkos functions so that they are annotated with the right Kokkos macro. Since it has been a while possibly something else I am missing ... :)

@fnrizzi
Copy link
Collaborator

fnrizzi commented Jul 31, 2024

Basically we added the cppkokkos to overcome the limitations of the cpp domain Sphinx had at that time (which is a while back now) but if the regular cpp domain supports similar things now, then I agree we should go with t that

@ajpowelsnl
Copy link
Contributor

@nmm0 - would you raise a PR to remove cppkokkos domain, and unfork us 😆

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

No branches or pull requests

3 participants