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 (2/2) #1379

Merged
merged 8 commits into from
Dec 11, 2020

Conversation

isaacgsmith
Copy link
Member

This is a follow-up to pull request #1371. Rearranges files in the docs folder to match the new structure of the documentation in pull request #1364.

Description

Major changes include:

  • Changing the folder docs/running to docs/using.
  • Moving the folders docs/models, docs/atomic, and docs/configuration into a new folder docs/using/components.
  • Creating a folder docs/physics/old_physics (which includes contents of the "Old Physics" section).

Motivation and Context

Issue #1357 called for a a restructuring of the TARDIS documentation. Both the documentation and the file paths now reflect the structure that issue called for.

How Has This Been Tested?

I built the documentation locally, and saw no new errors. I checked the html pages this PR would affect, and they worked 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 9, 2020

Codecov Report

Merging #1379 (9ffee87) into master (5236056) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1379   +/-   ##
=======================================
  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 5236056...9ffee87. Read the comment docs.

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.

Excellent work @smithis7 - this reorganization was much required!

And it's good to see that you created old_physics dir and moved related files in it. 👏

@andrewfullard andrewfullard merged commit ce5b665 into tardis-sn:master Dec 11, 2020
@isaacgsmith isaacgsmith deleted the reorganizing_2 branch December 11, 2020 18:22
This was referenced Dec 11, 2020
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