readthedocs: exclude sandbox and depreciated from apidoc - #623
Merged
Conversation
Fixes FABLE-3DXRD#491. sphinx-apidoc was scanning the whole ImageD11 package, including ImageD11/sandbox, which has modules doing top-level 'import PyTango' / 'import minuit' / 'import PyQt4' (none of them real dependencies, all listed under setup.py's 'rare' extra and absent from docs/sphx/requirements.txt). Autodoc importing those modules hung the build indefinitely rather than failing cleanly (reproduced locally: with sandbox included the build never returned; excluding it, the same build completes: "build succeeded, 149 warnings"). depreciated is excluded too since it has the same PyTango-import problem and is already excluded from the flake8 CI step for the same kind of reason. Note: getting the readthedocs project itself re-enabled after this is a support request only the project owner can make, not a code change.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #491. sphinx-apidoc was scanning the whole ImageD11 package, including ImageD11/sandbox, which has modules doing top-level 'import PyTango' / 'import minuit' / 'import PyQt4' (none of them real dependencies, all listed under setup.py's 'rare' extra and absent from docs/sphx/requirements.txt). Autodoc importing those modules hung the build indefinitely rather than failing cleanly (reproduced locally: with sandbox included the build never returned; excluding it, the same build completes: "build succeeded, 149 warnings"). depreciated is excluded too since it has the same PyTango-import problem and is already excluded from the flake8 CI step for the same kind of reason.
Note: getting the readthedocs project itself re-enabled after this is a support request only the project owner can make, not a code change.