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

Fixing SDEC labels bug in the documentation #1531

Merged
merged 1 commit into from Apr 22, 2021

Conversation

atharva-2001
Copy link
Member

@atharva-2001 atharva-2001 commented Apr 10, 2021

This aims to fix #1485

Description

As far as I know, plotly labels are not recognized as math objects and therefore MathJax is not loaded in the sphinx documentation. Adding an extra cell with latex in it forces MathJax to load and thus labels in plotly figure are rendered.
For reference please see:
spatialaudio/nbsphinx#369
plotly/plotly.py#1243
and this thread

Motivation and Context

resolves #1485

How Has This Been Tested?

  • Testing pipeline
  • Reference Data Comparison following these instructions
  • Other (please describe)

The labels are parsed correctly in my documentation

Screenshots (if appropriate):

Before:
image
After:
image

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • None of the above (please describe)

Checklist:

  • My code follows the code style of this project
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have built the documentation on my fork following these 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

@codecov
Copy link

codecov bot commented Apr 10, 2021

Codecov Report

Merging #1531 (f4bf41a) into master (b7eac7e) will not change coverage.
The diff coverage is n/a.

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

@@           Coverage Diff           @@
##           master    #1531   +/-   ##
=======================================
  Coverage   67.57%   67.57%           
=======================================
  Files          68       68           
  Lines        6100     6100           
=======================================
  Hits         4122     4122           
  Misses       1978     1978           

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 b7eac7e...76e9e72. Read the comment docs.

Copy link
Contributor

@marxwillia marxwillia left a comment

Choose a reason for hiding this comment

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

Great change.

@andrewfullard andrewfullard merged commit 6b44bc8 into tardis-sn:master Apr 22, 2021
atharva-2001 added a commit to atharva-2001/tardis that referenced this pull request May 23, 2021
@atharva-2001 atharva-2001 mentioned this pull request Jun 3, 2021
10 tasks
atharva-2001 added a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
@andrewfullard andrewfullard added this to Done in Documentation Jan 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

Axis Labels Not Parsing Correctly in SDEC Plot via Plotly
3 participants