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

fix: Build docs without parallelization to fix pop-up issues with sphinx-tippy #80

Merged
merged 5 commits into from
Oct 30, 2023

Conversation

nfelt14
Copy link
Collaborator

@nfelt14 nfelt14 commented Oct 30, 2023

Proposed changes

Run doc building without parallelization to try to work around a bug in sphinx-tippy.

Types of changes

What types of changes does your code introduce?
Put an x in the boxes that apply and remove the ones that don't

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation update (an update to enhance the user experience when reading through the docs)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have followed the guidelines in the CONTRIBUTING document
  • I have signed the CLA
  • I have checked to ensure there aren't other open Pull Requests for the same update/change
  • I have performed a self-review of my code
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • Basic linting passes locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added necessary documentation (if appropriate)
  • I have updated the Changelog with a brief description of my changes

@nfelt14 nfelt14 added bug Something isn't working documentation Improvements or additions to documentation labels Oct 30, 2023
@nfelt14 nfelt14 requested a review from a team as a code owner October 30, 2023 15:55
@nfelt14 nfelt14 temporarily deployed to package-build October 30, 2023 15:55 — with GitHub Actions Inactive
@nfelt14 nfelt14 requested a review from a team October 30, 2023 15:55
@codecov
Copy link

codecov bot commented Oct 30, 2023

Codecov Report

Merging #80 (6d5a34c) into main (e01e099) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main       #80   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          168       168           
  Lines         3768      3768           
  Branches       646       646           
=========================================
  Hits          3768      3768           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@nfelt14 nfelt14 enabled auto-merge (squash) October 30, 2023 15:57
@nfelt14 nfelt14 disabled auto-merge October 30, 2023 15:57
@nfelt14
Copy link
Collaborator Author

nfelt14 commented Oct 30, 2023

A normal doc build used to take about 45 minutes, but the pop-ups were non-functional. Now the build takes 65 minutes, but the pop-ups are functional.

@nfelt14 nfelt14 temporarily deployed to package-build October 30, 2023 17:14 — with GitHub Actions Inactive
@nfelt14
Copy link
Collaborator Author

nfelt14 commented Oct 30, 2023

This PR works around this issue: sphinx-extensions2/sphinx-tippy#9

@nfelt14 nfelt14 temporarily deployed to package-build October 30, 2023 18:04 — with GitHub Actions Inactive
@nfelt14 nfelt14 force-pushed the nfelt14/fix-tippy-pop-ups-in-docs branch from a3924cd to 1e57043 Compare October 30, 2023 21:23
@nfelt14 nfelt14 temporarily deployed to package-build October 30, 2023 21:23 — with GitHub Actions Inactive
@nfelt14 nfelt14 force-pushed the nfelt14/fix-tippy-pop-ups-in-docs branch from 1e57043 to b5d4a50 Compare October 30, 2023 21:24
@nfelt14 nfelt14 temporarily deployed to package-build October 30, 2023 21:24 — with GitHub Actions Inactive
It slowed the build down significantly, more than was acceptable.
@nfelt14 nfelt14 temporarily deployed to package-build October 30, 2023 21:25 — with GitHub Actions Inactive
@nfelt14 nfelt14 enabled auto-merge (squash) October 30, 2023 21:26
michaelwagoner
michaelwagoner previously approved these changes Oct 30, 2023
@nfelt14 nfelt14 disabled auto-merge October 30, 2023 22:15
@nfelt14 nfelt14 temporarily deployed to package-build October 30, 2023 22:17 — with GitHub Actions Inactive
@nfelt14 nfelt14 requested a review from ldantek October 30, 2023 22:25
@nfelt14 nfelt14 enabled auto-merge (squash) October 30, 2023 22:25
@nfelt14 nfelt14 temporarily deployed to package-build October 30, 2023 22:32 — with GitHub Actions Inactive
@nfelt14 nfelt14 merged commit f73afa9 into main Oct 30, 2023
34 checks passed
@nfelt14 nfelt14 deleted the nfelt14/fix-tippy-pop-ups-in-docs branch October 30, 2023 23:21
qthompso pushed a commit to qthompso/tm_devices that referenced this pull request Feb 15, 2024
…inx-tippy (tektronix#80)

* fix: Run the docs environment in tox without parallelization, since it seems that tippy has a bug when run in parallelization in sphinx.

* ci: Set up tags to be signed as well.

Signed-off-by: qthompso <[email protected]>
qthompso pushed a commit to qthompso/tm_devices that referenced this pull request Feb 16, 2024
…inx-tippy (tektronix#80)

* fix: Run the docs environment in tox without parallelization, since it seems that tippy has a bug when run in parallelization in sphinx.

* ci: Set up tags to be signed as well.
v12ganesh pushed a commit to v12ganesh/tm_devices that referenced this pull request Mar 28, 2024
…inx-tippy (tektronix#80)

* fix: Run the docs environment in tox without parallelization, since it seems that tippy has a bug when run in parallelization in sphinx.

* ci: Set up tags to be signed as well.
Signed-off-by: v12ganesh [email protected]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants