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.

Sign up for GitHub

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

Jump to bottom

Support Sphinx >3.0.0 #37

Open
chadell opened this issue Dec 11, 2020 · 0 comments
Open

Support Sphinx >3.0.0 #37

chadell opened this issue Dec 11, 2020 · 0 comments
Labels
documentation Documentation issue

Comments

@chadell
Copy link
Contributor

chadell commented Dec 11, 2020

Since Sphinx moved to 3.0.0, the current documentation build fails because:

/yangify/yangify/linter/__init__.py:docstring of yangify.linter.LinterResult.children:1:duplicate object description of yangify.linter.LinterResult.children, other instance in api/linter, use :noindex: for one of them
Makefile:62: recipe for target 'sphinx_test' failed

This new warning raised by Sphinx, also mentioned in googleapis/synthtool#593, is due to the nested children.

I found this issue while working on #36 and decided to leave the PR with Sphinx pinned to <3.0.0 and open this bug to track independently.
@chadell chadell added the documentation Documentation issue label Dec 11, 2020
@dgjustice dgjustice mentioned this issue Jan 28, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Documentation issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@chadell