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 Quickstart Metadata #1727

Merged
merged 2 commits into from Jul 16, 2021
Merged

Conversation

isaacgsmith
Copy link
Member

@isaacgsmith isaacgsmith commented Jul 15, 2021

Description

Makes it so quickstart notebook does not run when DISABLE_NBSPHINX=1.

Motivation and context

Fixing a mistake I made when working with #1711

How has this been tested?

  • Testing pipeline.
  • Docs built locally on GitHub (see below).

Examples

After running DISABLE_NBSPHINX=1 make html, I got:
image
See built documentation: https://smithis7.github.io/tardis/branch/patch-1/quickstart/quickstart.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 15, 2021

Codecov Report

Merging #1727 (6a87c7a) into master (1941410) will not change coverage.
The diff coverage is n/a.

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

@@           Coverage Diff           @@
##           master    #1727   +/-   ##
=======================================
  Coverage   61.87%   61.87%           
=======================================
  Files          63       63           
  Lines        5852     5852           
=======================================
  Hits         3621     3621           
  Misses       2231     2231           

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 1941410...204a2d3. Read the comment docs.

@isaacgsmith isaacgsmith requested review from Rodot- and andrewfullard and removed request for Rodot- July 15, 2021 18:26
@andrewfullard andrewfullard merged commit c9c3a0b into tardis-sn:master Jul 16, 2021
@isaacgsmith isaacgsmith deleted the patch-1 branch July 19, 2021 17:19
DhruvSondhi pushed a commit to DhruvSondhi/tardis that referenced this pull request Aug 1, 2021
* fix quickstart metadata

* [build docs]
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* fix quickstart metadata

* [build docs]
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.

None yet

4 participants