You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The command changes directory to 'py' but then uses 'cd' without arguments to return. This might not work as expected in all shell environments. Consider using 'cd -' or explicit 'cd ..' to return to the previous directory.
- cd py && python3 generate_api_module_listing.py && cd
- PYTHONPATH=py sphinx-autogen -o $READTHEDOCS_OUTPUT/html py/docs/source/api.rst
The cd command without arguments doesn't properly return to the original directory. Use cd .. instead to ensure you return to the parent directory after running the script.
-- cd py && python3 generate_api_module_listing.py && cd+- cd py && python3 generate_api_module_listing.py && cd ..
Apply / Chat
Suggestion importance[1-10]: 7
__
Why: The suggestion correctly identifies that cd without arguments goes to the home directory rather than returning to the original directory. This could cause subsequent commands to fail if they expect to be in the original working directory.
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.
User description
💥 What does this PR do?
I broke our readthedocs configuration in #15828 for publishing the Python API docs.
This attempts to fix it.
PR Type
Bug fix
Description
Fixes Python API docs generation command for ReadTheDocs
Updates
.readthedocs.yamlto correct script execution pathChanges walkthrough 📝
.readthedocs.yaml
Fix ReadTheDocs build command for Python API docspy/docs/.readthedocs.yaml
generate_api_module_listing.pyby changingto the
pydirectory before execution.builds.