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

Add support for more doxygen directive #9

Merged
merged 4 commits into from
May 11, 2021

Conversation

TonyWelte
Copy link
Contributor

@TonyWelte TonyWelte commented Apr 23, 2021

This PR adds support for several Doxygen directives:

  • the conversion of math formulas from "$formula$" to ":math:formula" to follow the reST format. This enables formulas to be correctly displayed with tools such as Sphinx

@TonyWelte TonyWelte changed the title Changed the math format to use the reST math role Draft: Add support for more doxygen directive Apr 26, 2021
@themarpe
Copy link
Contributor

@TonyWelte are deprecation tags also on your TODO? :)
Not sure how those are / should be converted, just wondering

@TonyWelte
Copy link
Contributor Author

I have added the tags:
\deprecated --> .. deprecated:: (reST expects a version number so the first word is assumed to be the version number)
\since --> .. versionadded::
\todo --> .. todo::
Warning: I haven't been able to test this, I'm suffering from #2

@themarpe
Copy link
Contributor

themarpe commented May 3, 2021

@TonyWelte

Nice! And these can be written both with \ and @ right?

Check my PR for #2 -> #10 and let me know if it works for you:)

@TonyWelte
Copy link
Contributor Author

@themarpe Yes, both \ and @ can be used.

Thanks for #10, I was able to test it and fix an issue. It should be done now.

@TonyWelte TonyWelte changed the title Draft: Add support for more doxygen directive Add support for more doxygen directive May 6, 2021
@henryiii henryiii merged commit 956b3f9 into pybind:master May 11, 2021
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.

3 participants