https://github.com/jobindjohn/jbtest
JupyterBook on ReadtheDocs
https://github.com/jobindjohn/jbtest
jupyterbook readthedocs readthedocs-demo
Last synced: 3 months ago
JSON representation
JupyterBook on ReadtheDocs
- Host: GitHub
- URL: https://github.com/jobindjohn/jbtest
- Owner: jobindjohn
- Created: 2022-06-23T20:52:44.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-18T13:20:36.000Z (over 2 years ago)
- Last Synced: 2025-01-27T23:18:45.042Z (5 months ago)
- Topics: jupyterbook, readthedocs, readthedocs-demo
- Language: TeX
- Homepage: https://jbtest.readthedocs.io/
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Host Jupyter Book on ReadtheDocs
This is the Jupyter Book sample hosted on ReadtheDocs
Setting up the `.readthedocs.yaml` can be tricky if you are doing it for the first time.
This can get your Jupyter Book hosted ReadtheDocs out-of-the-box.
In the example below, the name of the book is `jbtest`. Check out the repo for the structure.
```yaml
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.8"
jobs:
pre_build:
# Generate the Sphinx configuration for this Jupyter Book so it builds.
- "jupyter-book config sphinx jbtest/"
python:
install:
- requirements: jbtest/requirements.txt
sphinx:
builder: html
fail_on_warning: true
```