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.

Sign up for GitHub

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

Jump to bottom

SDEC Visibility Fix #1607

Merged
merged 3 commits into from
Jun 3, 2021
Merged

SDEC Visibility Fix #1607

merged 3 commits into from
Jun 3, 2021

Conversation

atharva-2001
Copy link
Member

@atharva-2001 atharva-2001 commented Jun 3, 2021 •
edited
Loading

This PR causes SDEC plots to show up again.

Description

MathJax.Hub doesn't exist anymore in MathJax v3, which is used in the documentation and causes plotly plots to not show up.
This PR removes the extra cell I added to load MathJax and changes conf.py to load MathJax v2 in the documentation.
MathJax v2 doesn't give any errors when running MathJax.Hub and the plots show up.
This is a temporary fix until a permanent solution is found.
For reference, please see
spatialaudio/nbsphinx#572
#1531

Motivation and context

resolves #1585

How has this been tested?

  • Testing pipeline.
  • Other.

Examples

Please see the preview here

Before After
image image

Type of change

  • Bug fix.
  • New feature.
  • Breaking change.
  • None of the above.

Checklist

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
    • (optional) I have built the documentation on my fork following the instructions.
  • I have assigned and requested two reviewers for this pull request.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@github-actions
Copy link

github-actions bot commented Jun 3, 2021

Before a PR is accepted, it must meet the following criteria:

  • Is the necessary information provided?
    • Does the PR have a complete description? Does it explain what the PR is attempting to do/fix, does it explain how it does this?
    • Is there an explanation of why this PR is needed?
    • Please use the TARDIS PR template
  • Is this a duplicate PR?
    • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
    • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
  • Does it pass existing tests and are new tests provided if required?
    • The test coverage should not decrease, and for new features should be at or very close to 100%.
  • Is the code properly documented?
    • If this modifies existing code, then the docs should be updated. If this adds a new feature, additional documentation should be created.
    • Sphinx and docstrings in the code (in numpydoc format)
  • Does this conform to PEP 8 and the TARDIS style guidelines?
  • Does the PR fix the problem it describes?
    • Make sure it doesn’t e.g. just fix the problem for a specific case
    • Is this the best way of fixing the problem?
  • Is the code tidy?
    • No unnecessary print lines or code comments

@github-actions
Copy link

github-actions bot commented Jun 3, 2021

Before a PR is accepted, it must meet the following criteria:

  • Is the necessary information provided?
    • Does the PR have a complete description? Does it explain what the PR is attempting to do/fix, does it explain how it does this?
    • Is there an explanation of why this PR is needed?
    • Please use the TARDIS PR template
  • Is this a duplicate PR?
    • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
    • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
  • Does it pass existing tests and are new tests provided if required?
    • The test coverage should not decrease, and for new features should be at or very close to 100%.
  • Is the code properly documented?
    • If this modifies existing code, then the docs should be updated. If this adds a new feature, additional documentation should be created.
    • Sphinx and docstrings in the code (in numpydoc format)
  • Does this conform to PEP 8 and the TARDIS style guidelines?
  • Does the PR fix the problem it describes?
    • Make sure it doesn’t e.g. just fix the problem for a specific case
    • Is this the best way of fixing the problem?
  • Is the code tidy?
    • No unnecessary print lines or code comments

@Rodot-
Copy link
Contributor

Rodot- commented Jun 3, 2021

/azp run update-refdata

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Update succeeded e6b4c4f

Changes pushed to tardis-sn/tardis-refdata.

@atharva-2001 atharva-2001 force-pushed the sdec_visibility_fix branch from de79c3f to de652d4 Compare June 3, 2021 14:27
@codecov
Copy link

codecov bot commented Jun 3, 2021 •
edited
Loading

Codecov Report

Merging #1607 (fae8fda) into master (bdeb1a6) will not change coverage.
The diff coverage is n/a.

❗ Current head fae8fda differs from pull request most recent head de652d4. Consider uploading reports for the commit de652d4 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1607   +/-   ##
=======================================
  Coverage   67.20%   67.20%           
=======================================
  Files          73       73           
  Lines        6150     6150           
=======================================
  Hits         4133     4133           
  Misses       2017     2017

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ba54c99...de652d4. Read the comment docs.

jaladh-singhal
jaladh-singhal approved these changes Jun 3, 2021
View reviewed changes
Copy link
Member

@jaladh-singhal jaladh-singhal left a comment

Choose a reason for hiding this comment

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

Excellent! @atharva-2001 since it is a workaround, I'll suggest:

  1. To open an issue in plotly repo
  2. To keep an eye for the proper fix when it comes

@jaladh-singhal jaladh-singhal merged commit 2bba59c into tardis-sn:master Jun 3, 2021
@atharva-2001
Copy link
Member Author

Thank you! I will do it 🚀

@atharva-2001 atharva-2001 mentioned this pull request Jun 6, 2021
Closed
atharva-2001 added a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
@atharva-2001
SDEC Visibility Fix (tardis-sn#1607)
e3155f3 
* removing latex cell

* using mathjax v2

* [build docs]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jaladh-singhal jaladh-singhal jaladh-singhal approved these changes

@andrewfullard andrewfullard andrewfullard approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

SDEC plotly graphs not showing in the documentation
4 participants
@atharva-2001 @Rodot- @andrewfullard @jaladh-singhal