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

Cannot configure the Sphinx nitpick_ignore option #42

Open
jgosmann opened this issue Jun 10, 2019 · 0 comments
Open

Cannot configure the Sphinx nitpick_ignore option #42

jgosmann opened this issue Jun 10, 2019 · 0 comments

Comments

@jgosmann
Copy link

nengo-bones enforces that the Sphinx configuration is also created with nengo-bones and enables nitpicky by default. However, the Nengo SPA documentation references certain Nengo types in automatically linked fields that cannot be resolved (e.g. nengo.base.NengoObject which is not included in the public Nengo API documentation, but the appropriate type to use in the Nengo SPA documentation). These could in theory be ignored with the nitpick_ignore option, but this option requires a list of tuples which cannot be specified in the YAML file (YAML only has lists, but not tuples, a list instead of a tuple does not work with Sphinx).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant