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

generated doc do not please nitpicky. #7

Open
ninoles opened this issue Oct 18, 2017 · 0 comments
Open

generated doc do not please nitpicky. #7

ninoles opened this issue Oct 18, 2017 · 0 comments

Comments

@ninoles
Copy link

ninoles commented Oct 18, 2017

Adding the -n options to sphinx-build will generate a warning to all properties. Just taking the GithubUser in the README.rst example, this is what I got:

E:\Test\jsondomain\doc\source\jsonobj.rst:: WARNING: json:prop reference target not found: login
E:\Test\jsondomain\doc\source\jsonobj.rst:: WARNING: json:prop reference target not found: id
E:\Test\jsondomain\doc\source\jsonobj.rst:: WARNING: json:prop reference target not found: avatar_url
E:\Test\jsondomain\doc\source\jsonobj.rst:: WARNING: json:prop reference target not found: gravatar_url

My impression is that the make_xref should be override to create proper xref for props, (like "GithubUser.login" instead of just "login") but I'm not sure since I cannot see where the reference are created (the bug happen even with :noindex: set).

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

1 participant