Initialize Jupyter Book documentation - Githubissues

Clay-foundation / model

The Clay Foundation Model (in development)

https://clay-foundation.github.io/model/

Apache License 2.0

299 stars 38 forks source link

Initialize Jupyter Book documentation #89

Closed weiji14 closed 8 months ago

weiji14 commented 8 months ago

What I am changing

Documentation website built with Jupyter-Book/Sphinx.
Preview at https://clay-foundation.github.io/model/intro.html
Screenshot:

How I did it

Follow instructions at https://jupyterbook.org/en/stable/start/create.html
Deployed to GitHub Pages via GitHub Actions - https://jupyterbook.org/en/stable/publish/gh-pages.html#automatically-host-your-book-with-github-actions
Based on https://github.com/geo-smart/deepicedrainpipe/pull/2

TODO in this PR:

[x] Add jupyter-book dependency
[x] Initialize minimal Jupyter-Book site
[x] Setup GitHub Actions CI to build docs and push to GitHub Pages
[x] Add more sections on sidebar

How you can test it

Run jupyter-book build docs/ locally

Related Issues