Initialize Jupyter Book documentation #89
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Build a book with Jupyter Notebooks and Sphinx!
Starting with a minimally modified Jupyter Book initialized with `jupyter-book create docs/`. Changed the `_config.yml` to use a proper title and the Clay logo. Included a Binder launch button and a footer with CC-BY-4.0 license. Deleted the sample notebooks.ipynb and markdown-notebooks.md files, and excluded the book/requirements.txt (dependencies will be installed from environment.yml). Put in a placeholder installation page for now in the Table of Contents.
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, but modernized to use GitHub Actions based publishing source, see https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta
The package list is shown in the Setup Micromamba step already.
weiji14
commented
Dec 15, 2023
Comment on lines
+6
to
+10
| parts: | ||
| - caption: Getting Started | ||
| chapters: | ||
| - title: Installation | ||
| file: installation |
There was a problem hiding this comment.
What sections/subsections should we put on the sidebar? My initial ideas are:
- Getting started
- Installation
- Data Preparation
- Preparing the datacube
- Preparing labels for evaluation model performance
- Running the model
- Self-supervised learning
- Linear Probing?
- Generating embeddings
- Self-supervised learning
There was a problem hiding this comment.
- I would add a paragraph about the clay foundation and a link to the linkedin page.
- We could add a section about how to run the datacube in batch
There was a problem hiding this comment.
Ok, added a link to the LinkedIn (and GitHub) page at commit bcbf080. Gonna merge this PR soon, so I'll open a separate issue to discuss about what sections/sub-sections to add later. I actually think the batch run could be a sub-section under 'Preparing the datacube, but we can discuss about this.
weiji14
commented
Dec 15, 2023
Add external links to Clay's GitHub organization page, and LinkedIn.
Add badges pointing to the Jupyter Book page, and for the deploy-book.yml/test.yml GitHub Action statuses below the title in the main README.md page. Also modified the description into something more compelling.
This reverts commit cc05a87.
Some copy-paste errors.
7 tasks
brunosan
pushed a commit
that referenced
this pull request
Dec 27, 2023
* ➕ Add jupyter-book Build a book with Jupyter Notebooks and Sphinx! * 📝 Initialize Jupyter Book Starting with a minimally modified Jupyter Book initialized with `jupyter-book create docs/`. Changed the `_config.yml` to use a proper title and the Clay logo. Included a Binder launch button and a footer with CC-BY-4.0 license. Deleted the sample notebooks.ipynb and markdown-notebooks.md files, and excluded the book/requirements.txt (dependencies will be installed from environment.yml). Put in a placeholder installation page for now in the Table of Contents. * 🚀 Deploy Jupyter Book to GitHub Pages via GitHub Actions 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, but modernized to use GitHub Actions based publishing source, see https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta * 📝 Add 'About Clay' section with links to GitHub and LinkedIn pages Add external links to Clay's GitHub organization page, and LinkedIn. * 🔍 Add badges to main README.md Add badges pointing to the Jupyter Book page, and for the deploy-book.yml/test.yml GitHub Action statuses below the title in the main README.md page. Also modified the description into something more compelling.
This was referenced Jan 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What I am changing
How I did it
TODO in this PR:
How you can test it
jupyter-book build docs/locallyRelated Issues