Ensure api directory is present to build documentation
#16467
Merged
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
|
Thanks for making a pull request to jupyterlab! |
krassowski
changed the title
api directory is present to build documentation
|
@meeseeksdev please backport to 4.2.x |
meeseeksmachine
pushed a commit
to meeseeksmachine/jupyterlab
that referenced
this pull request
Jun 10, 2024
…ild documentation
krassowski
pushed a commit
that referenced
this pull request
Jun 10, 2024
…ntation (#16469) Co-authored-by: Darshan Poudel <127468609+Darshan808@users.noreply.github.com>
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.
References
This PR addresses the issue #16466
Issue
When running make html, the build process fails with the following error:
FileNotFoundError: [WinError 3] The system cannot find the path specified: '...\\jupyterlab\\docs\\source\\api'Code changes
This PR addresses an issue where the documentation build process fails if the api directory is not present. Specifically, running make html results in a FileNotFoundError because Sphinx expects the docs/source/api directory to exist.
Since the api directory is under .gitignore, it is not present in a newly cloned repo. To solve this, I added a few lines of code to create the api directory if it is not present during the documentation build process. This ensures that the api directory is always present, so Sphinx doesn't raise any errors.
After modifying the make.bat file, docs build successfully in windows:
Additional Context: