Fixing issue #1177 #1361
Merged
Fixing issue #1177 #1361
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Codecov Report
@@ Coverage Diff @@
## master #1361 +/- ##
=======================================
Coverage 71.77% 71.77%
=======================================
Files 66 66
Lines 5077 5077
=======================================
Hits 3644 3644
Misses 1433 1433 Continue to review full report at Codecov.
|
andrewfullard
approved these changes
Nov 30, 2020
atharva-2001
pushed a commit
to atharva-2001/tardis
that referenced
this pull request
Oct 1, 2021
* fixing issue tardis-sn#1177 * fixing notebook headers so they don't show up in toc * fixing toctree for docs/running/index * adding notebooks to toctree * fixing notebook headings to not show up in toctree
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I have added notebooks to toctrees in both
docs/running/index.rstanddocs/running/interaction/index.rst. I also fixed the cross-references indocs/running/to_hdf.rst.Motivation and Context
This pull request fixes issue #1177 .
How Has This Been Tested?
I built the docs locally and went through the html documents to make sure the code did exactly what I wanted it to do. I did not see the correct results for the cross-references in
docs/running/to_hdf.rst, however I read that things done with:ref::would not appear when run locally (I believe).In order to build the documentation, I had to add
nbsphinx_allow_errors = Trueintodocs/conf.py. I am not committing that change unless I am asked to do so.Screenshots (if appropriate):
Types of changes
Checklist: