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

Reorganizing files in docs (1/2) #1371

Merged
merged 10 commits into from
Dec 9, 2020

Conversation

isaacgsmith
Copy link
Member

@isaacgsmith isaacgsmith commented Dec 6, 2020

This is the first of two pull requests reorganizing files in docs in order to match the new structure of the documentation.

Description

In this pull request I have:

  • Deleted extraneous files in docs resulting from pull request Fixing issue #1357 #1364
  • Fixed the problems cited by Jaladh in pull request Fixing issue #1357 #1364
  • Puts everything on the "Additional Interactivity" page into the folder docs/running/interaction

Motivation and Context

This fixes some remaining issues in issue #1357 that were not properly addressed in pull request #1364. It also begins the process of reorganizing the files in docs to better match the structure of the documentation (I was forced to include some of the reorganizing in this pull request or else some of the other changes I made would not go through. This is because of the order I made those changes prior to being told to have the "cleaning up" and "reorganizing" changes in two separate pull requests-- so I apologize to the people reviewing this).

How Has This Been Tested?

I locally built the documentation and everything worked out properly.

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

@codecov
Copy link

codecov bot commented Dec 6, 2020

Codecov Report

Merging #1371 (28e161a) into master (1249c4e) will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1371      +/-   ##
==========================================
+ Coverage   71.72%   71.73%   +0.01%     
==========================================
  Files          66       66              
  Lines        5071     5073       +2     
==========================================
+ Hits         3637     3639       +2     
  Misses       1434     1434              
Impacted Files Coverage Δ
tardis/tardis/montecarlo/base.py 84.78% <0.00%> (+0.16%) ⬆️

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 1249c4e...28e161a. Read the comment docs.

@andrewfullard andrewfullard linked an issue Dec 7, 2020 that may be closed by this pull request
Copy link
Member

@jaladh-singhal jaladh-singhal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks great @smithis7 - I just had a brief request in new_plasma (guess I was not very clear last time).

docs/running/interaction/index.rst Show resolved Hide resolved
docs/physics/new_plasma.rst Outdated Show resolved Hide resolved
Plasma
******
*****************
Plasma (Outdated)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call!

Copy link
Member

@jaladh-singhal jaladh-singhal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@andrewfullard andrewfullard merged commit 1c706d5 into tardis-sn:master Dec 9, 2020
@isaacgsmith isaacgsmith deleted the cleaning_docs branch December 11, 2020 18:24
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.

Restructure documentation to make sidebar look more informative
3 participants