-
-
Notifications
You must be signed in to change notification settings - Fork 424
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
Restructuring TARDIS Documentation (Issue #948) #1077
Restructuring TARDIS Documentation (Issue #948) #1077
Conversation
Please let me know if this PR needs some changes.
|
@shreyansjain012 Please be more descriptive in your PR titles and description. I think @wkerzendorf wants you to move this formal integral page under configuration section. Additionally, have a look at past gitter chat where he explained about it |
I went to see previous chats but didn't find any mentions regarding this issue. |
Wait until @wkerzendorf can reply you back. Meanwhile, go through documentation and identify if there is something that needs to be restructured as per you? |
* installation.rst: rephrased the content * running/index.rst: changed `Running TARDIS` to `TARDIS Configuration File` * Moved running/interaction/integrator.ipynb to configuration/integrator.ipynb * Updated configuration/index.rst * corrected dead link
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.
@shreyansjain012 It looks good to me so far!
@wkerzendorf could you cross-check parts specific to #948 like:
And give him more pointers about what you mean by "move stella to helper scripts"?
Hi! Please rebase this branch and check that there are no conflicts with the new documentation edits introduced in #1158. |
closing as outdated |
This PR addresses some of the changes needed in TARDIS documentation.
Description
docs/installation.rst
: Rephrased the contentdocs/running/index.rst
: Changed Running TARDIS to TARDIS Configuration Filedocs/running/interaction/integrator.ipynb
→docs/configuration/integrator.ipynb
docs/configuration/
: Added a link tointegrator
reading blondin toymodel.ipynb
toreading_blondin_toymodel.ipynb
Motivation and Context
How Has This Been Tested?
make html
and verified that each change is working.OS - Ubuntu 18.04
Screenshots (if appropriate):
Outdated syntax
![syntax_error](https://user-images.githubusercontent.com/45244830/76189516-edf50000-6200-11ea-978f-161ee375e534.png)
Types of changes
Checklist: