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 docs for website release #1835

Merged
merged 8 commits into from
Dec 10, 2021

Conversation

isaacgsmith
Copy link
Member

@isaacgsmith isaacgsmith commented Nov 30, 2021

This will not be merged until the website release.

Description

Reorganizes the sidebar for the website release, as well as reorganizing some files. More description to come.

Motivation and context

We are getting a new website!

How has this been tested?

  • Testing pipeline.
  • Other.

Examples

https://smithis7.github.io/tardis/branch/reorg_for_website_doc/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

@codecov
Copy link

codecov bot commented Nov 30, 2021

Codecov Report

Merging #1835 (93aad07) into master (8716466) will decrease coverage by 0.37%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1835      +/-   ##
==========================================
- Coverage   58.04%   57.66%   -0.38%     
==========================================
  Files          66       66              
  Lines        6747     6808      +61     
==========================================
+ Hits         3916     3926      +10     
- Misses       2831     2882      +51     
Impacted Files Coverage Δ
...dis/montecarlo/montecarlo_numba/numba_interface.py 35.64% <0.00%> (-10.52%) ⬇️
tardis/tardis/montecarlo/montecarlo_numba/base.py 25.00% <0.00%> (-1.22%) ⬇️
tardis/tardis/analysis.py 30.16% <0.00%> (ø)
...rdis/tardis/montecarlo/montecarlo_configuration.py 100.00% <0.00%> (ø)
tardis/tardis/montecarlo/base.py 88.94% <0.00%> (+0.17%) ⬆️
.../montecarlo/montecarlo_numba/single_packet_loop.py 29.78% <0.00%> (+2.66%) ⬆️

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 8716466...93aad07. Read the comment docs.

@tardis-bot
Copy link
Contributor

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.

@isaacgsmith isaacgsmith removed the request for review from marxwillia December 8, 2021 01:09
@isaacgsmith isaacgsmith marked this pull request as ready for review December 10, 2021 03:32
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.

Thanks for making this PR - I guess this marks final cleanup of tardis docs 🎉

Besides my comments, can you please also delete news.rst and remove it from homepage - it's on main website and belongs there only.

I was thinking to move mission to main website as well since it applies to all packages we provide (and will provide). Let me know if you agree - I'll create a Mission page there and then you can delete it from here?

docs/index.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
@isaacgsmith
Copy link
Member Author

@jaladh-singhal I will at some later point see about better ways to link the docs and the website

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.

Thanks for changes!

@andrewfullard andrewfullard merged commit 48f56f1 into tardis-sn:master Dec 10, 2021
@isaacgsmith isaacgsmith deleted the reorg_for_website_doc branch December 10, 2021 20:53
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