DM-27060: pipe_base documentation fails to build due to BuildId #151
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These types cause a documentation build failure: FileNotFoundError: [Errno 2] No such file or directory: '/j/ws/sqre/infra/documenteer/doc_template/_build/doctree/py-api/lsst.pipe.base.BuildId.doctree' Presumably because Sphinx/autodoc doesn't understand that they are generated by typing.NewType rather than being fully-fledged classes.
TallJimbo
approved these changes
Oct 5, 2020
There was a problem hiding this comment.
Telling Sphinx to ignore these seems like the best fix for now.
But if these types are causing problems because they're being used to document (e.g.) function arguments, I might ask @natelust to open a ticket to change that, too, because having docs reference a pseudo-type that can only be understood by looking at the code doesn't seem like good practice. Using NewType in type annotations is okay; using it in docstrings apparently isn't right now.
Thanks for tracking this down!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These types cause a documentation build failure:
FileNotFoundError: [Errno 2] No such file or directory: '/j/ws/sqre/infra/documenteer/doc_template/_build/doctree/py-api/lsst.pipe.base.BuildId.doctree'
Presumably because Sphinx/autodoc doesn't understand that they are generated
by typing.NewType rather than being fully-fledged classes.