-
Notifications
You must be signed in to change notification settings - Fork 1
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
doxygen docu and @keywords rendering #228
Comments
Thanks so much for taking the time to write up and provide the versions. Looking at the docs I don't think I did a good job documenting which doxygen markups are supported. There is https://sphinx-c-autodoc.readthedocs.io/en/latest/directives.html#directive-autocfunction, but it's not clear that only the markup that clang understands in functions will be used. It's also not documented what is understood by clang. This means the The Are you able to share the C source code that generated the output that might help identify why the returns isn't being picked up. |
I just noticed that I can't render niether The project: https://github.com/libcsp/libcsp You can see https://github.com/libcsp/libcsp/actions/runs/9405110214 is the last doc build on GitHub Actions. Things I've tried (and failed):
Does anybody have any idea? |
I wanted to try your sphinx-c-autodoc to document one of my zephyr projects. The code is entirely written in c. It works quite well at least for the configuration and building. The rendered code documentation seems not to work as expected.
The source.rst looks like this
it is then rendered like this:
The doxygen docu and @Keywords are not really rendered properly.
versions used:
Do you have a clue what the issue might be? Many Thanks in advance!
Thomas
The text was updated successfully, but these errors were encountered: