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

Reorganize the documentation a bit. #156

Merged
merged 1 commit into from
Sep 17, 2020
Merged

Conversation

ntouran
Copy link
Member

@ntouran ntouran commented Sep 17, 2020

This moves the installation, gallery, and tutorials to the main sidebar
for easy discovery and a good guideline of how to get started. We also
added a currently-empty News section (for blogs and announcements).

Also:

  • Updated color of heading to be a TP color
  • Merged the README into the front page so it's a one stop shop
    and you can scroll as far as you want before peeling off easily.
  • Cleaned up how the input files get passed between unit tests
    and the documentation jupyter notebooks
  • Added github integration links ("edit on github")
  • Tuned up the intro paragraph

This moves the installation, gallery, and tutorials to the main sidebar
for easy discovery and a good guideline of how to get started. We also
added a currently-empty News section (for blogs and announcements).

Also:

* Updated color of heading to be a TP color
* Merged the README into the front page so it's a one stop shop
  and you can scroll as far as you want before peeling off easily.
* Cleaned up how the input files get passed between unit tests
  and the documentation jupyter notebooks
* Added github integration links ("edit on github")
* Tuned up the intro paragraph
@ntouran ntouran added cleanup Code/comment cleanup: Low Priority documentation Improvements or additions to documentation labels Sep 17, 2020
@@ -308,7 +314,12 @@ def setup(app):
"_static/gallery.css", # for the sphinx-gallery plugin
"_static/gallery-binder.css",
"_static/gallery-dataframe.css",
]
],
"display_github": True, # Integrate GitHub
Copy link
Contributor

Choose a reason for hiding this comment

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

That Was Easy

@ntouran ntouran merged commit a285bc3 into terrapower:master Sep 17, 2020
@ntouran ntouran deleted the docreorg branch September 17, 2020 23:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Code/comment cleanup: Low Priority documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants