Fix API docs script to tolerate empty docs folder #1316
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
Eric-Arellano
commented
May 7, 2024
| @@ -128,10 +128,9 @@ async function prepareSphinxFolder(pkg: Pkg, args: Arguments): Promise<string> { | |||
|
|
|||
| async function deleteExistingMarkdown(pkg: Pkg): Promise<void> { | |||
| const markdownDir = pkg.outputDir("docs"); | |||
| if (pkg.isLatest() || (await pathExists(markdownDir))) { | |||
There was a problem hiding this comment.
I don't think it's necessary to check if pkg.isLatest() - it's already covered by the pathExists check. If the path does not exist, then there is nothing to delete, regardless of latest or not.
arnaucasau
approved these changes
May 7, 2024
arnaucasau
reviewed
May 7, 2024
Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
Eric-Arellano
added a commit
that referenced
this pull request
May 7, 2024
This was getting in the way of adding the new qiskit-transpiler-service docs, since its folder is empty. This also was a problem when rerunning the script if the folder had been previously deleted without having restored the deleted files before the rerun. --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
This was getting in the way of adding the new qiskit-transpiler-service docs, since its folder is empty. This also was a problem when rerunning the script if the folder had been previously deleted without having restored the deleted files before the rerun. --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@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.
This was getting in the way of adding the new qiskit-transpiler-service docs, since its folder is empty. This also was a problem when rerunning the script if the folder had been previously deleted without having restored the deleted files before the rerun.