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 docs building problem #1387

Merged
merged 13 commits into from
Dec 16, 2020

Conversation

isaacgsmith
Copy link
Member

This pull request should fix issues that caused build errors in the documentation.

Description

File paths in symlinks and notebooks are changed to reflect the reorganization of the files in pull request #1379.

Motivation and Context

Following pull request #1379, the change in file paths and file names caused build errors in the documentation, as the notebooks did not function properly. Pull request #1382 fixed one of these problems, but due to technical problems on my end I was unable to test the rest of the notebooks locally when working on #1382 . This pull request fixes the remainder of the issues.

How Has This Been Tested?

After doing some troubleshooting in slack and with Andrew, I got the locally built the documentation successfully with all of the notebooks running correctly.

Screenshots (if appropriate):

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)

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 assigned/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

@epassaro
Copy link
Member

epassaro commented Dec 14, 2020

Hi @smithis7

  1. Your links are still broken :( To check which softlinks are not pointing to files use:

    find . -type l ! -exec test -e {} \; -print
    

    inside the docs/ folder.

    My advice to fix softlinks is: a) cd to the folder where the softlink lives b) make your changes c) go up to docs/ and use the
    above command to check if the new link worked. Remember the path you need to use is relative, so count how many times you need to go up doing ../.

  2. Try to commit notebooks you modified in this PR with cleared output, otherwise the number of diff lines is too high on every PR.

  3. Also I think there are more references to the old URL (that starting with raw.github...) you changed on your previous PR. Look for them!

Good work!

@codecov
Copy link

codecov bot commented Dec 14, 2020

Codecov Report

Merging #1387 (fb071ab) into master (162f280) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1387   +/-   ##
=======================================
  Coverage   72.39%   72.39%           
=======================================
  Files          66       66           
  Lines        5097     5097           
=======================================
  Hits         3690     3690           
  Misses       1407     1407           

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 162f280...fb071ab. Read the comment docs.

@epassaro epassaro mentioned this pull request Dec 16, 2020
11 tasks
@andrewfullard andrewfullard merged commit 943bab3 into tardis-sn:master Dec 16, 2020
andrewfullard added a commit that referenced this pull request Dec 16, 2020
andrewfullard added a commit that referenced this pull request Dec 16, 2020
@isaacgsmith isaacgsmith deleted the notebook_problem_fix branch December 16, 2020 17:31
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* Update tardis_example.yml

* Update density.dat

* Update abund.dat

* Update base.yml

* Update model.yml

* Update model.yml

* Update montecarlo.yml

* Update plasma.yml

* Update spectrum.yml

* Update supernova.yml

* fixing references to files

* clearing outputs

* fixing link in quickstart
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.

3 participants