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

domains: c: add missing intersphinx object types #8188

Merged
merged 1 commit into from Sep 12, 2020

Conversation

utzig
Copy link
Contributor

@utzig utzig commented Sep 9, 2020

For intersphinx to be able to resolve references to C-Domain objects, it needs to have them declared in the obj_types dict. This is currently missing enum, enumerator, struct and union so those can't be referenced by an external project. This commit fixes the issue by adding them.

For intersphinx to be able to resolve references to C-Domain objects, it
needs to have them declared in the obj_types dict. This is currently
missing enum, enumerator, struct and union so those can't be referenced
by an external project. This commit fixes the issue by adding them.

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
@utzig
Copy link
Contributor Author

utzig commented Sep 9, 2020

@jakobandersen This is one commit broken away from #8160. I am adding a project attached, with the current build already there in the html folder, but you can run them yourself if you prefer so. If you look at the obj_types html folder, everything is OK, but ext_proj which uses intersphinx to resolve the symbols some are broken (and fixed by this commit). I also found out :c:member: does not work and :c:macro can't have the () for it to work, but those are not my focus right now...
c_intersphinx_samples.tar.gz

@utzig
Copy link
Contributor Author

utzig commented Sep 9, 2020

@jakobandersen This is one commit broken away from #8160. I am adding a project attached, with the current build already there in the html folder, but you can run them yourself if you prefer so. If you look at the obj_types html folder, everything is OK, but ext_proj which uses intersphinx to resolve the symbols some are broken (and fixed by this commit). I also found out :c:member: does not work and :c:macro can't have the () for it to work, but those are not my focus right now...
c_intersphinx_samples.tar.gz

Ah, I also added struct and union because they were broken, although my initial commit was only concerned with enum and enumerator!

@jakobandersen jakobandersen merged commit 46a6b08 into sphinx-doc:3.2.x Sep 12, 2020
@jakobandersen
Copy link
Contributor

Thanks!

@utzig utzig deleted the fix-c-domain-intersphinx branch September 12, 2020 23:57
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 24, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants