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 #1643

Merged
merged 24 commits into from
Jun 14, 2021
Merged

Conversation

isaacgsmith
Copy link
Member

@isaacgsmith isaacgsmith commented Jun 8, 2021

This is part 1 of a series of PRs restructuring the documentation. Please view the built documentation here.

Description

There are a lot of changes made. The overarching themes of these changes are as follows:

  • Removes "using TARDIS" section
  • Creates "I/O" section which is differently organized
  • Splits the configuration documentation into many different pages, and incorporates the atomic and models sections in it
  • Creates "outdated" section
  • Reorganizes physics to be a walkthrough of the code (more changes to come regarding that)
  • Hyperlink and referencing fixes

Motivation and context

This is part of an ongoing project to make the documentation as interactive and easy-to-understand as possible.

How has this been tested?

  • Testing pipeline.
  • Other.
    Documentation has been built.

Examples

See the top of this PR for the link to the built documentation.

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

@isaacgsmith isaacgsmith marked this pull request as ready for review June 10, 2021 17:40
@tardis-bot
Copy link
Contributor

tardis-bot commented Jun 10, 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.

Copy link
Contributor

@andrewfullard andrewfullard left a comment

Choose a reason for hiding this comment

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

Generally good. Left a few comments. I hope you've tested all the new links to make sure nothing is broken.

docs/io/configuration/components/index.rst Outdated Show resolved Hide resolved
docs/outdated/index.rst Show resolved Hide resolved
tardis/io/schemas/csvy_model.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@andrewfullard andrewfullard left a comment

Choose a reason for hiding this comment

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

Please fix the test failures caused by the relocation/rename/editing of some csvy configuration files

@codecov
Copy link

codecov bot commented Jun 11, 2021

Codecov Report

Merging #1643 (c8d96aa) into master (8ceacc0) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1643   +/-   ##
=======================================
  Coverage   67.13%   67.13%           
=======================================
  Files          73       73           
  Lines        6100     6100           
=======================================
  Hits         4095     4095           
  Misses       2005     2005           

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 8ceacc0...c8d96aa. 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.

@wkerzendorf wkerzendorf merged commit 049aa34 into tardis-sn:master Jun 14, 2021
@isaacgsmith isaacgsmith deleted the restructure branch June 15, 2021 14:33
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* moving files

* removing files and moving images

* outdated section

* creating new files

* lots of file changes

* deleting schemas so I can redo it

* fixing schemas

* fixing symlinks

* fixing warnings, organizing files in toctrees

* editing index [build docs]

* removing comments in csvy schema

* more progress [build docs]

* last major changes for io docs

* fixing warnings

* [build docs]

* fixing typo [build docs]

* fixing warnings [build docs]

* andrew's changes [build docs]

* fixing test failure [build docs]

* second attempt fixing test failure [build docs]

* third attempt fixing test failure [build docs]

* third attempt fixing test failure [build docs]

* fixing yamls [build docs]

* fixing yamls [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