https://github.com/gordonsmith/my_book
https://github.com/gordonsmith/my_book
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gordonsmith/my_book
- Owner: GordonSmith
- License: other
- Created: 2020-09-22T12:53:06.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-22T12:55:43.000Z (over 5 years ago)
- Last Synced: 2025-04-05T20:31:31.122Z (about 1 year ago)
- Language: TeX
- Size: 354 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# my-book
This cookiecutter creates a simple boilerplate for a Jupyter Book.
## Usage
### Building the book
If you'd like to develop on and build the my-book book, you should:
- Clone this repository and run
- Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)
- (Recommended) Remove the existing `my-book/_build/` directory
- Run `jupyter-book build my-book/`
A fully-rendered HTML version of the book will be built in `my-book/_build/html/`.
### Hosting the book
The html version of the book is hosted on the `gh-pages` branch of this repo. A GitHub actions workflow has been created that automatically builds and pushes the book to this branch on a push or pull request to master.
If you wish to disable this automation, you may remove the GitHub actions workflow and build the book manually by:
- Navigating to your local build; and running,
- `ghp-import -n -p -f my-book/_build/html`
This will automatically push your build to the `gh-pages` branch. More information on this hosting process can be found [here](https://jupyterbook.org/publish/gh-pages.html#manually-host-your-book-with-github-pages).
## Contributors
We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/GordonSmith/my_book/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).