Initialize Jupyter Book #3
Conversation
Starting with a minimally modified Jupyter Book initialized with `jupyter-book create book/`. Changed the `_config.yml` to use a proper title and the EGU22 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.
Continuous Integration workflow to build the Jupyter Book's html pages and publish it online to GitHub Pages. Based on https://jupyterbook.org/en/stable/publish/gh-pages.html#automatically-host-your-book-with-github-actions
| # Install dependencies | ||
| - name: Set up Python 3.9 | ||
| uses: actions/setup-python@v3.1.2 | ||
| with: | ||
| python-version: 3.9 |
There was a problem hiding this comment.
Will need to change this to use miniconda/mambaforge in a follow up PR, because GMT needs to be installed using conda. But this will suffice for now.
|
|
||
| title: Crafting beautiful maps with PyGMT | ||
| author: The PyGMT Team | ||
| logo: logo.svg |
There was a problem hiding this comment.
Is it possible to make the logo clickable to follow the policy at https://www.egu.eu/visual-identity/?
There was a problem hiding this comment.
Went down a deep rabbit hole... Apparently it was possible in jupyter-book 0.7 but they did a refactor that removed this feature, see jupyter-book/jupyter-book#740. It might actually need to be done through the sphinx theme? See also executablebooks/sphinx-book-theme#325
There was a problem hiding this comment.
Still couldn't find a way to add a link to the logo after looking at https://jupyterbook.org/en/stable/advanced/sphinx.html, so I've just added a link to https://www.egu22.eu on the sidebar. Done in 896e555 and looks like this now
Starting with a minimally modified Jupyter Book initialized with
jupyter-book create book/. Changed the_config.ymlto use a proper title and the EGU22 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 it at https://www.generic-mapping-tools.org/egu22pygmt/intro.html
Steps to run locally:
cd egu22pygmt mamba env create --file environment.yml mamba activate egu22pygmt jupyter-book create book/ jupyter-book build book/TODO:
References: