Add objects.inv #522
Merged
Add objects.inv #522
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
frankharkins
commented
Dec 14, 2023
UpdateThe following links are broken according to the link checker:
|
frankharkins
commented
Jan 15, 2024
scripts/lib/links/ignores.ts
Outdated
There was a problem hiding this comment.
I think the number of broken links is low enough I can ignore them here rather than disabling checking completely. The advantages are:
- We're less likely to forget about
objects.invwhen we decide to address the broken links - We'll still be alerted to new broken links in future
objects.invfiles
arnaucasau
reviewed
Jan 16, 2024
There was a problem hiding this comment.
Awesome work, thank you Frank! Just one question, I was testing it regenerating a historical version and the script generated the file public/api/qiskit/0.44 instead of public/api/qiskit/0.44/objects.inv. Is that the intended behavior?
I think the reason is the extname thinks .44 is the extension of a file and it doesn't join the path with objects.inv in objectsInv.ts.
async write(path: string): Promise<void> {
if (extname(path) === "") {
path = join(path, "objects.inv");
}
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
|
Thanks both for the reviews! @arnaucasau good catch with the historical apis script; it's working now. |
Eric-Arellano
approved these changes
Jan 17, 2024
Comment on lines
+90
to
+92
| if (filePath.endsWith(".inv")) { | ||
| return await parseObjectsInv(filePath); | ||
| } |
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 18, 2024
The API generation script is now able to work with `objects.inv` files thanks to @frankharkins at #522. This PR allows us to copy over the objects.file when we want to make a version historical running `npm run make-historical -- -p <projectName>`.
frankharkins
added a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
This is prework for Qiskit#522, which adds `sphinx.inv`. We want to check the links contained in `sphinx.inv`, but we don't expect anyone to have links pointing to `sphinx.inv`. Our original abstractions made it hard to model `objects.inv` correctly with the link checker. Now, `markdown.ts` is renamed to `extractLinks.ts` and it solely deals with parsing files. It no longer has a bad coupling to the complex `linksToOriginFiles` variable from `FileBatch.ts`. This should make it much more obvious how to handle `objects.inv`. --------- Co-authored-by: Frank Harkins <frankharkins@hotmail.co.uk>
frankharkins
added a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
- Added `objectsInv.ts` to read, decompress, and parse `objects.inv` files (and vice versa) - Updated `updateApiDocs.ts` to copy the file over from the artifact - Added logic to transform links and delete any references that don't exist in our docs ### Explanation The `objects.inv` file is an index that [intersphinx](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html) uses to create cross-references to our documentation. To allow other projects to cross-reference Qiskit, we need to host this file. For a description of the file's data structure, see the [sphobjinv documentation](https://sphobjinv.readthedocs.io/en/stable/syntax.html), whose implementation I copied when working out how to transform this file. --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
The API generation script is now able to work with `objects.inv` files thanks to @frankharkins at Qiskit#522. This PR allows us to copy over the objects.file when we want to make a version historical running `npm run make-historical -- -p <projectName>`.
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.
objectsInv.tsto read, decompress, and parseobjects.invfiles (and vice versa)updateApiDocs.tsto copy the file over from the artifactExplanation
The
objects.invfile is an index that intersphinx uses to create cross-references to our documentation. To allow other projects to cross-reference Qiskit, we need to host this file.For a description of the file's data structure, see the sphobjinv documentation, whose implementation I copied when working out how to transform this file.