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

Clean up docs handling #216

Merged
merged 7 commits into from
Apr 4, 2022
Merged

Conversation

blink1073
Copy link
Contributor

@blink1073 blink1073 commented Apr 2, 2022

  • Generate CLI docs
  • Test docs with warnings
  • Prevent downstream errors when docstrings contain things that are ambiguously directives or ambiguous classes, cf Clean up workflows nbconvert#1750
Warning, treated as error:
/Users/silvester/workspace/nbconvert/docs/source/config_options.rst:2194:more than one target found for 'any' cross-reference 'CellExecutionError': could be :py:class:`nbconvert.preprocessors.CellExecutionError` or :py:class:`nbclient.exceptions.CellExecutionError`
Warning, treated as error:
/Users/silvester/workspace/nbconvert/docs/source/config_options.rst:2293:'any' reference target not found: cell

@blink1073 blink1073 added the documentation Improvements or additions to documentation label Apr 2, 2022
@blink1073
Copy link
Contributor Author

Failures are unrelated.

Copy link
Member

@davidbrochart davidbrochart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, CI failures are unrelated.

@blink1073 blink1073 merged commit 6e8b16c into jupyter:main Apr 4, 2022
@blink1073 blink1073 deleted the fix-target-ambiguity branch April 4, 2022 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants