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

Skip binaries in the docs build script #904

Merged
merged 6 commits into from
Sep 11, 2024
Merged

Conversation

maliasadi
Copy link
Member

@maliasadi maliasadi commented Sep 10, 2024

Before submitting

Please complete the following checklist when submitting a PR:

  • All new features must include a unit test.
    If you've fixed a bug or added code that should be tested, add a test to the
    tests directory!

  • All new functions and code must be clearly commented and documented.
    If you do make documentation changes, make sure that the docs build and
    render correctly by running make docs.

  • Ensure that the test suite passes, by running make test.

  • Add a new entry to the .github/CHANGELOG.md file, summarizing the
    change, and including a link back to the PR.

  • Ensure that code is properly formatted by running make format.

When all the above are checked, delete everything above the dashed
line and fill in the pull request template.


Context:
Skip the build of Lightning sims binaries and dev requirements for pulbic documentations. This will speed up the build of docs from +3000 seconds to 700 seconds.

Description of the Change:

Benefits:

Possible Drawbacks:

Related GitHub Issues:
[sc-73505]

Copy link
Contributor

Hello. You may have forgotten to update the changelog!
Please edit .github/CHANGELOG.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

@maliasadi maliasadi marked this pull request as ready for review September 11, 2024 16:22
@maliasadi maliasadi added the urgent Mark a pull request as high priority label Sep 11, 2024
Copy link

codecov bot commented Sep 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.29%. Comparing base (3d005f0) to head (cea36e4).
Report is 1 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (3d005f0) and HEAD (cea36e4). Click for more details.

HEAD has 4 uploads less than BASE
Flag BASE (3d005f0) HEAD (cea36e4)
10 6
Additional details and impacted files
@@             Coverage Diff             @@
##           master     #904       +/-   ##
===========================================
- Coverage   96.23%   57.29%   -38.95%     
===========================================
  Files         212       24      -188     
  Lines       28318     2255    -26063     
===========================================
- Hits        27252     1292    -25960     
+ Misses       1066      963      -103     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@vincentmr vincentmr left a comment

Choose a reason for hiding this comment

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

Looks good to me, nice improvement to the CI @maliasadi .

.readthedocs.yml Show resolved Hide resolved
Copy link
Contributor

@AmintorDusko AmintorDusko left a comment

Choose a reason for hiding this comment

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

Great job! Thank you for that! Docs are super fast now!

@maliasadi maliasadi merged commit bbb3eb4 into master Sep 11, 2024
67 of 76 checks passed
@maliasadi maliasadi deleted the fix_preinstall_docs branch September 11, 2024 18:09
multiphaseCFD pushed a commit that referenced this pull request Sep 11, 2024
### Before submitting

Please complete the following checklist when submitting a PR:

- [ ] All new features must include a unit test.
If you've fixed a bug or added code that should be tested, add a test to
the
      [`tests`](../tests) directory!

- [ ] All new functions and code must be clearly commented and
documented.
If you do make documentation changes, make sure that the docs build and
      render correctly by running `make docs`.

- [ ] Ensure that the test suite passes, by running `make test`.

- [ ] Add a new entry to the `.github/CHANGELOG.md` file, summarizing
the
      change, and including a link back to the PR.

- [ ] Ensure that code is properly formatted by running `make format`. 

When all the above are checked, delete everything above the dashed
line and fill in the pull request template.


------------------------------------------------------------------------------------------------------------

**Context:**
Skip the build of Lightning sims binaries and dev requirements for
pulbic documentations. This will speed up the build of docs from +3000
seconds to 700 seconds.

**Description of the Change:**

**Benefits:**

**Possible Drawbacks:**

**Related GitHub Issues:**
[sc-73505]

---------

Co-authored-by: ringo-but-quantum <github-ringo-but-quantum@xanadu.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
urgent Mark a pull request as high priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants