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

Resolving warnings in ADS notebook #1598

Merged
merged 2 commits into from
Jun 1, 2021

Conversation

isaacgsmith
Copy link
Member

This is a small PR that resolves several sphinx warnings that result from documentation builds.

Description

  • Adds a double underscore in the hyperlinks generated by the ADS notebook.
  • Adds a title and explanation to the ADS notebook.
  • Updates list generated by ADS notebook.

Motivation and context

Resolves sphinx warnings.

How has this been tested?

  • Testing pipeline.
  • Other.
    Local documentation build and built on github.

Examples

https://smithis7.github.io/tardis/branch/fixing_warnings_doc/research/research_done_using_TARDIS/research_papers.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

@codecov
Copy link

codecov bot commented Jun 1, 2021

Codecov Report

Merging #1598 (275ba2b) into master (a8a719b) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1598   +/-   ##
=======================================
  Coverage   67.20%   67.20%           
=======================================
  Files          73       73           
  Lines        6147     6147           
=======================================
  Hits         4131     4131           
  Misses       2016     2016           

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 a8a719b...275ba2b. Read the comment docs.

@andrewfullard andrewfullard merged commit 6967320 into tardis-sn:master Jun 1, 2021
@isaacgsmith isaacgsmith deleted the fixing_warnings_doc branch June 1, 2021 14:54
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* fixing ADS links and giving ads.ipynb a title

* [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.

3 participants