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

"Unparseable C cross-reference" when building #88

Closed
dmalan opened this issue Jun 1, 2020 · 1 comment · Fixed by #92
Closed

"Unparseable C cross-reference" when building #88

dmalan opened this issue Jun 1, 2020 · 1 comment · Fixed by #92
Labels

Comments

@dmalan
Copy link
Member

dmalan commented Jun 1, 2020

/mnt/library/c.rst:66: WARNING: Unparseable C cross-reference: 'char *'
@dmalan dmalan added the bug label Jun 1, 2020
@jsarchibald
Copy link
Contributor

It's implied in the documentation that we can only use the :type: syntax if we're referencing a type we've defined in the documentation. Problem is, if we define the types in the documentation ourselves, then the definitions will also appear in our docs, and we'll have to deal with a list of C types at the bottom of the page.

For now, I think the simplest solution is to just change :type: to :code: where it appears. The only drawback is aesthetics, since the text will be red, not black. (There was no actual cross-reference to a type before, so no link is disappearing; the only difference is the text color.)
image

I've also posted a question on Stack Overflow (here) so will wait to see if the internet has any alternatives that I haven't thought of.

@jsarchibald jsarchibald mentioned this issue Aug 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging a pull request may close this issue.

2 participants