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

Initialize Jupyter Book #3

Merged
merged 11 commits into from
Sep 22, 2024
Merged

Initialize Jupyter Book #3

merged 11 commits into from
Sep 22, 2024

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Sep 21, 2024

Starting with a minimally modified Jupyter Book initialized with jupyter-book create book/. Changed the _config.yml to use a proper title and the AGU24 logo. Included a Binder launch button and a footer with CC-BY-4.0 license. Also added a JupyterBook badge to the main README.md.

Preview at https://www.generic-mapping-tools.org/agu24workshop/intro.html

Jupyter Book page

Steps to run locally:

cd agu24workshop
mamba env create --file environment.yml
mamba activate agu24workshop

jupyter-book create book/
jupyter-book build book/

TODO:

References:

Starting with a minimally modified Jupyter Book initialized with `jupyter-book create book/`. Changed the `_config.yml` to use a proper title and the AGU24 logo. Included a Binder launch button and a footer with CC-BY-4.0 license. Also added a JupyterBook badge to the main README.md.
@weiji14 weiji14 self-assigned this Sep 21, 2024
@weiji14 weiji14 added the documentation Improvements or additions to documentation label Sep 21, 2024
@weiji14 weiji14 marked this pull request as ready for review September 21, 2024 03:18
book/_config.yml Outdated Show resolved Hide resolved
- caption: Details
chapters:
- title: AGU24 Homepage
url: https://www.agu.org/annual-meeting
Copy link
Member

Choose a reason for hiding this comment

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

At the moment this link seems to resolve the website for the 2024 fall meeting. But I think later we have to update the link, as in 2025 this link will probably resolve the 2025 fall meeting website >.<.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I wished they just used a permanent URL like https://www.agu.org/fall-meeting-2024 directly. Will try to remember to change this next year!

Copy link
Member

@yvonnefroehlich yvonnefroehlich left a comment

Choose a reason for hiding this comment

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

Thanks for getting started here @weiji14.
So far, I only made a suggestion regarding the authors and a comment regarding the AGU website.

@weiji14
Copy link
Member Author

weiji14 commented Sep 22, 2024

Thanks @yvonnefroehlich! I'll merge this in first, so that people can start adding things to the table of contents.

@weiji14 weiji14 merged commit 3b4bb50 into main Sep 22, 2024
1 check passed
@weiji14 weiji14 deleted the init/jupyter-book branch September 22, 2024 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants