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 #2

Merged
merged 7 commits into from
Nov 3, 2022
Merged

📝 Initialize Jupyter Book #2

merged 7 commits into from
Nov 3, 2022

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Nov 3, 2022

Starting with a minimally modified Jupyter Book initialized with jupyter-book create book/. Changed the _config.yml to use a proper title and the GeoSmart 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://geo-smart.github.io/deepicedrainpipe/intro.html

Main webpage for DeepIceDrain Jupyter Book, screenshot.

Steps to run locally:

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

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 GeoSmart 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.

Deleted the sample notebooks.ipynb and markdown-notebooks.md files, and excluded the book/requirements.txt (dependencies will be installed from environment.yml). Updated the sample citation the the 2022 ICESat-2 Hackweek Jupyter Book website DOI.
@weiji14 weiji14 added the documentation Improvements or additions to documentation label Nov 3, 2022
@weiji14 weiji14 self-assigned this Nov 3, 2022
@weiji14 weiji14 temporarily deployed to github-pages November 3, 2022 19:26 Inactive
@weiji14
Copy link
Member Author

weiji14 commented Nov 3, 2022

Note to self: Needed to temporarily add this Pull Request's init/jupyter-book branch to the allowed list of deployment branches for the gh-pages environment at https://github.com/geo-smart/deepicedrainpipe/settings/environments:

Adding init/jupyter-book branch to the allowlist, screenshot.

Will remove this temporary setting once this Pull Request is merged.

@weiji14 weiji14 temporarily deployed to github-pages November 3, 2022 19:40 Inactive
@weiji14 weiji14 temporarily deployed to github-pages November 3, 2022 19:57 Inactive
@weiji14 weiji14 marked this pull request as ready for review November 3, 2022 20:11
@weiji14 weiji14 merged commit d8d8d4c into main Nov 3, 2022
@weiji14 weiji14 deleted the init/jupyter-book branch November 3, 2022 20:20
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.

1 participant