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

📚 New docs theme & Add comments #74

Merged
merged 10 commits into from
Mar 15, 2021
Merged

Conversation

andersy005
Copy link
Contributor

  • Closes move examples to jupyterbook + comments` #72 by adding comments and annotation functionality via sphinx-comments
  • sphinx_rtd_theme --> sphinx-book-theme
  • uses myst-nb/myst-parser
  • Docs can be written in markdown, ipynb and (rst if need be).

navbar_footer_text='',
extra_footer="""Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a>""",
)

html_logo = 'images/nsf.png'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mnlevy1981, does POP have a logo we could use here? If so, could you point me to it when you get a moment?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think there is one, but I've asked one of the LANL developers to be sure. I'll let you know if I hear anything back.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks!

@andersy005
Copy link
Contributor Author

@dcherian, here's the new layout with comments enabled:

Screen Shot 2021-03-15 at 8 21 13 AM

@dcherian
Copy link
Contributor

LGTM. I think it's worth trying the comment feature. Not sure whether anyone will use it, butit's free!

@andersy005 andersy005 changed the title New docs theme & Add comments 📚 New docs theme & Add comments Mar 15, 2021
@andersy005 andersy005 merged commit 20622e8 into NCAR:master Mar 15, 2021
@andersy005 andersy005 deleted the docs-overhaul branch March 15, 2021 19:32
dcherian added a commit to dcherian/pop-tools that referenced this pull request Mar 19, 2021
* upstream/master:
  📚 New docs theme & Add comments (NCAR#74)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

move examples to jupyterbook + comments`
3 participants