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

Changing Note Format in Visualization Notebooks #1755

Merged
merged 1 commit into from
Jul 27, 2021

Conversation

isaacgsmith
Copy link
Member

Description

This is a small PR that just changes how notes are rendered in markdown cells. This allows sphinx to render the notes as sphinx notes.

How has this been tested?

  • Testing pipeline.
  • Docs built locally and on GitHub.

Examples

Here are the two pages being edited -- see how the notes look:
https://smithis7.github.io/tardis/branch/note_doc/io/visualization/generating_widgets.html
https://smithis7.github.io/tardis/branch/note_doc/io/visualization/sdec_plot.html

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

@tardis-bot
Copy link
Contributor

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

  • Is the necessary information provided?
  • 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 close to 100%.
  • Is the code tidy?
    • No unnecessary print lines or code comments.

@codecov
Copy link

codecov bot commented Jul 26, 2021

Codecov Report

Merging #1755 (ceccdd1) into master (8caeca3) will not change coverage.
The diff coverage is n/a.

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

@@           Coverage Diff           @@
##           master    #1755   +/-   ##
=======================================
  Coverage   62.45%   62.45%           
=======================================
  Files          64       64           
  Lines        5985     5985           
=======================================
  Hits         3738     3738           
  Misses       2247     2247           

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 8903c13...e51f69f. Read the comment docs.

@wkerzendorf wkerzendorf merged commit dd4c124 into tardis-sn:master Jul 27, 2021
@isaacgsmith isaacgsmith deleted the note_doc branch July 27, 2021 20:41
DhruvSondhi pushed a commit to DhruvSondhi/tardis that referenced this pull request Aug 1, 2021
DhruvSondhi pushed a commit to DhruvSondhi/tardis that referenced this pull request Aug 9, 2021
DhruvSondhi pushed a commit to DhruvSondhi/tardis that referenced this pull request Aug 9, 2021
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants