https://github.com/chepo92/jupyterbook-example
https://github.com/chepo92/jupyterbook-example
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/chepo92/jupyterbook-example
- Owner: chepo92
- License: mit
- Created: 2021-07-23T00:34:01.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-23T01:04:47.000Z (almost 4 years ago)
- Last Synced: 2025-02-04T18:48:37.379Z (4 months ago)
- Language: TeX
- Homepage: https://chepo92.github.io/jupyterbook-example/
- Size: 1.62 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# IBM2026 course
The content of the IBM2026 course
## Usage
### Building the book
If you'd like to develop and/or build the IBM2026 course book, you should:
1. Clone this repository
2. Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)
3. (Optional) Edit the books source files located in the `ibm2026_course/` directory
4. Run `jupyter-book clean ibm2026_course/` to remove any existing builds
5. Run `jupyter-book build ibm2026_course/`
A fully-rendered HTML version of the book will be built in `ibm2026_course/_build/html/`.
### Hosting the book
Please see the [Jupyter Book documentation](https://jupyterbook.org/publish/web.html) to discover options for deploying a book online using services such as GitHub, GitLab, or Netlify.
For GitHub and GitLab deployment specifically, the [cookiecutter-jupyter-book](https://github.com/executablebooks/cookiecutter-jupyter-book) includes templates for, and information about, optional continuous integration (CI) workflow files to help easily and automatically deploy books online with GitHub or GitLab. For example, if you chose `github` for the `include_ci` cookiecutter option, your book template was created with a GitHub actions workflow file that, once pushed to GitHub, automatically renders and pushes your book to the `gh-pages` branch of your repo and hosts it on GitHub Pages when a push or pull request is made to the main branch.
## Contributors
We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/chepo92/ibm2026_course/graphs/contributors).
## Credits
This project is created using the excellent open source [Jupyter Book project](https://jupyterbook.org/) and the [executablebooks/cookiecutter-jupyter-book template](https://github.com/executablebooks/cookiecutter-jupyter-book).