Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add integration test of qiskit-sphinx-theme #960

Merged
merged 3 commits into from
Mar 5, 2024
Merged

Conversation

Eric-Arellano
Copy link
Collaborator

Closes #715.

This is useful generally for better testing of our conversion pipeline, as it's our only test that tests the entire conversion pipeline.

It also is useful to allow us to easily compare Sphinx's behavior vs. our app's behavior, like the PDFs I uploaded in #947.

--

I didn't document this in the README because we don't talk about testing in the README currently. Our README is already quite long, so I was hesitant to add to it since most technical writers don't care about testing, unlike Jupyter notebook testing that we do document.

Instead, I documented the test file itself. I'm not sure if this is clear enough.

@Eric-Arellano Eric-Arellano marked this pull request as ready for review March 5, 2024 15:02
Copy link
Collaborator

@arnaucasau arnaucasau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work Eric!! I like a lot how the previous refactors help making this code easy to follow. It was my first time looking at how snapshots work and I think the instructions at the beginning of the test file are super helpful.

scripts/lib/api/conversionPipeline.test.ts Outdated Show resolved Hide resolved
scripts/lib/api/conversionPipeline.test.ts Outdated Show resolved Hide resolved
Eric-Arellano and others added 2 commits March 5, 2024 14:06
Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
@Eric-Arellano Eric-Arellano added this pull request to the merge queue Mar 5, 2024
Merged via the queue into main with commit aa3ec4e Mar 5, 2024
2 checks passed
@Eric-Arellano Eric-Arellano deleted the EA/integration-test branch March 5, 2024 20:30
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
Closes Qiskit#715.

This is useful generally for better testing of our conversion pipeline,
as it's our only test that tests the entire conversion pipeline.

It also is useful to allow us to easily compare Sphinx's behavior vs.
our app's behavior, like the PDFs I uploaded in
Qiskit#947.

--

I didn't document this in the README because we don't talk about testing
in the README currently. Our README is already quite long, so I was
hesitant to add to it since most technical writers don't care about
testing, unlike Jupyter notebook testing that we do document.

Instead, I documented the test file itself. I'm not sure if this is
clear enough.

---------

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
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add integration test for API docs based on qiskit-sphinx-theme
2 participants