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

Restructuring TARDIS Documentation (Issue #948) #1077

Closed
wants to merge 5 commits into from
Closed

Restructuring TARDIS Documentation (Issue #948) #1077

wants to merge 5 commits into from

Conversation

shreyansjain012
Copy link

@shreyansjain012 shreyansjain012 commented Mar 3, 2020

This PR addresses some of the changes needed in TARDIS documentation.

Description

  • docs/installation.rst: Rephrased the content
  • docs/running/index.rst: Changed Running TARDIS to TARDIS Configuration File
  • docs/running/interaction/integrator.ipynbdocs/configuration/integrator.ipynb
  • docs/configuration/: Added a link to integrator
  • The first link of the notebook given here was dead because of spacing between the name. Renamed reading blondin toymodel.ipynb to reading_blondin_toymodel.ipynb
  • Many files still contains python2 syntax, update files to use python3 syntax

Motivation and Context

  • Good documentation is always required for a large project.

How Has This Been Tested?

  • Ran documentation on a local server using make html and verified that each change is working.

OS - Ubuntu 18.04

Screenshots (if appropriate):

Outdated syntax
syntax_error

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@shreyansjain012
Copy link
Author

shreyansjain012 commented Mar 3, 2020

Please let me know if this PR needs some changes.
Also if you can elaborate these:

  • move formal integral to configuration
  • move stella to helper scripts

@shreyansjain012 shreyansjain012 changed the title Fixes #948 Issue #948 Mar 3, 2020
@jaladh-singhal
Copy link
Member

@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

@jaladh-singhal jaladh-singhal self-assigned this Mar 5, 2020
@jaladh-singhal jaladh-singhal changed the title Issue #948 Restructuring TARDIS Documentation (Issue #948) Mar 5, 2020
@shreyansjain012
Copy link
Author

@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.
Care to explain it again? 😅

@jaladh-singhal
Copy link
Member

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
@ebjordi ebjordi reopened this May 14, 2020
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.

@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"?

@ebjordi
Copy link
Contributor

ebjordi commented Jun 17, 2020

Hi! Please rebase this branch and check that there are no conflicts with the new documentation edits introduced in #1158.

@wkerzendorf
Copy link
Member

closing as outdated

@wkerzendorf wkerzendorf closed this Nov 4, 2020
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.

TARDIS documentation restructure (I of many)
4 participants