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

Restructure Documentation pt. 2 #1659

Merged
merged 9 commits into from
Jun 23, 2021

Conversation

isaacgsmith
Copy link
Member

This is the second part in a series of PRs restructuring the documentation.

Description

  • An introduction has been written for the four sections of the physics walkthrough.
  • Monte Carlo basic principles has been rewritten and combined with the random sampling information.
  • Image files have been moved.
  • Model information has been moved from propagation to its own page, but a summary was left on the propagation page.
  • A page about basic spectrum generation has been written.
  • A page about convergence has been created.
  • Broken hyperlinks have been fixed.

How has this been tested?

  • Testing pipeline.
  • Other.
    Documentation was built locally and on GitHub

Examples

View the built documentation here:
https://smithis7.github.io/tardis/branch/restructure-2/index.html

Type of change

  • Bug fix.
  • New feature.
  • Breaking change.
  • None of the above.

Checklist

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
    • (optional) I have built the documentation on my fork following the instructions.
  • I have assigned and 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

@tardis-bot
Copy link
Contributor

tardis-bot commented Jun 18, 2021

Before a pull request is accepted, it must meet the following criteria:

  • Is the necessary information provided?
  • Is this a duplicate PR?
    • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
    • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
  • Does it pass existing tests and are new tests provided if required?
    • The test coverage should not decrease, and for new features should be close to 100%.
  • Is the code tidy?
    • No unnecessary print lines or code comments.

@codecov
Copy link

codecov bot commented Jun 18, 2021

Codecov Report

Merging #1659 (f320c37) into master (1016ed0) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1659   +/-   ##
=======================================
  Coverage   61.93%   61.93%           
=======================================
  Files          62       62           
  Lines        5729     5729           
=======================================
  Hits         3548     3548           
  Misses       2181     2181           

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 1016ed0...f320c37. Read the comment docs.

@wkerzendorf wkerzendorf merged commit 05f759a into tardis-sn:master Jun 23, 2021
@isaacgsmith isaacgsmith deleted the restructure-2 branch June 24, 2021 22:39
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* making new files

* editing physics content and moving images

* error fixes and writing content

* basic spectrum and pyplot filepath

* more content and hyperlink fixes

* [build docs]

* making basic principles in terms of photons and fixing headings in propagation

* [build docs]

* [build docs]
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.

4 participants