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 issue #1357 #1364

Merged
merged 8 commits into from
Dec 4, 2020
Merged

Conversation

isaacgsmith
Copy link
Member

I restructured the TARDIS documentation to match the expected solution in issue #1357.

Description

I edited toctrees and created new files in order to get the documentation to look the proper way. I will have another pull request coming up that will delete the extraneous files resulting from these changes, as well as reorganizing files in the documentation's source code.

Motivation and Context

This pull request fixes issue #1357.

How Has This Been Tested?

I ran the documentation locally, and everything checked out (see the screenshot below-- I tested more than just that, but the screenshot shows that the scrollbar on the documentation matches the expected solution on issue #1357.

Screenshots (if appropriate):

pullrequest2

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.

@codecov
Copy link

codecov bot commented Dec 1, 2020

Codecov Report

Merging #1364 (ebe33c5) into master (6564a5e) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1364   +/-   ##
=======================================
  Coverage   71.77%   71.77%           
=======================================
  Files          66       66           
  Lines        5077     5077           
=======================================
  Hits         3644     3644           
  Misses       1433     1433           

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 6564a5e...ebe33c5. Read the comment docs.

@andrewfullard andrewfullard self-requested a review December 2, 2020 14:45
* **Principal Investigator**
- Wolfgang Kerzendorf
* **TARDIS CORE** [alphabetical]
- Yssavo Camacho-Neves, Andreas Flörs, Alice Harpole, Vytautas Jancauskas, Wolfgang Kerzendorf (founder), Luke Shingles, Stuart Sim (founder), Christian Vogl, Marc Williamson
Copy link
Contributor

Choose a reason for hiding this comment

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

I should be in here too ;)

Copy link
Member

Choose a reason for hiding this comment

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

add yourself

Copy link
Member Author

Choose a reason for hiding this comment

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

@andrewfullard you're added!

@jaladh-singhal jaladh-singhal self-requested a review December 3, 2020 10:27
@andrewfullard andrewfullard merged commit 5ae8d7c into tardis-sn:master Dec 4, 2020
@jaladh-singhal
Copy link
Member

jaladh-singhal commented Dec 4, 2020

@andrewfullard you're very quick - I had yet to review it! 😅

Even @smithis7 has some doubts I needed to answer because issue was created by me!

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.

Great work @smithis7 🎉

Besides specific review comments, I have three more things to add:

  • Take out "Accessing Physical Quantites" from Old Physics section to running/interaction - as shown in Restructure documentation to make sidebar look more informative #1357
  • Rename title in CONTRIBUTING.md as "Contribution Guidelines"
  • Make sure you delete the files from which you have extracted content to form new files like alumni.rst, goverance.rst, etc. - to make sure unnecessary files don't get piled up which will be difficult to remove later.

docs/running/gui.rst Show resolved Hide resolved
docs/physics/old_physics.rst Show resolved Hide resolved
docs/running/interaction/index.rst Show resolved Hide resolved
docs/physics/new_plasma.rst Show resolved Hide resolved
docs/physics/new_plasma.rst Show resolved Hide resolved
@isaacgsmith isaacgsmith deleted the issue_1357_fix branch December 4, 2020 20:50
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants