-
-
Notifications
You must be signed in to change notification settings - Fork 409
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 Models #1454
Reorganizing Models #1454
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Codecov Report
@@ Coverage Diff @@
## master #1454 +/- ##
=======================================
Coverage 71.13% 71.13%
=======================================
Files 67 67
Lines 5523 5523
=======================================
Hits 3929 3929
Misses 1594 1594 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry it took me so long - I nearly forgot to review this. This looks great @smithis7 🎉
* reorganizing files * fixing a few warnings * moving some files around * merging models/examples/examples, models/examples/index, and models/examples/modelconfig into models/index * deleting models/csy/csv_test.ipynb * changing header
This pull request reorganizes the "Models" section of the documentation (
docs/using/components/models/
) to include all relevant files, make the files more organized, and get rid of redundancies.Description
Changes include:
docs/using/components/models
along with all relevant files used. This includes moving the files fromdocs/yml_files/densitycust
into the the proper directory..../models/examples/examples.rst
,.../models/examples/index.rst
, and.../models/examples/modelconfig.rst
into.../models/index.rst
to eliminate redundancies and extraneous files.run_simple_example.ipynb
in.../models/examples/tardis_example.rst
..../models/csy/csvy_test.ipynb
.I organized this the way I thought it would work best. If that is not how it is supposed to be, please let me know. If you are reviewing this, you may want to take a look at that second bullet point to make sure no important information was lost.
Motivation and Context
This pull request addresses problems raised in issue #1437.
How Has This Been Tested?
I built the documentation locally. The number of warnings decreased, and everything built as expected.
Screenshots (if appropriate):
Types of changes
Documentation reorganization
Checklist: