Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 3.92 KB

README.md

File metadata and controls

40 lines (29 loc) · 3.92 KB

This Handbook is in development

This book is developed based on the TeachBook template (https://teachbooks.io/manual).

How to get started

Features

  • A github repository structure (/book) for making a TeachBook: a Jupyter Book v1 for educational purposes
  • An empty TeachBook containing an intro page on root, an example markdown page, an example jupyter notebook page, an example references page. and an example credits page. (/book/_toc.yml, /book/_config.yml, /book/credits.md, /book/intro.md, /book/references.md, /book/some_content/overview.md, /book/some_content/text_and_code.ipynb)
  • A file ready for adding references (references.bib, /book/references.md)
  • An example favicon (web browser icon) (/book/figures/favicon.ico, book/_config.yml.)
  • An example logo (/book/figures/TUDelft_logo_rgb.png, /book/config.yml)
  • The configuration files set ready to make your Jupyter Notebooks pages work with live code using our sphinx-thebe extension and our recommended settings (/book/config.yml)
  • An example of setting up preprocessing your table of contents to hide certain draft chapters for eg. students (_toc.yml)
  • A file containing all the recommended software packages (requirements.txt)
  • A file containing the recommended license CC BY 4.0 (LICENSE.md)
  • Our GitHub workflow for publishing your TeachBook to GitHub Pages (.github/workflow/call-deploy-book.yml)
  • A gitignore file containing standard python filetype to ignore (.gitignore)
  • A readme containing information how to use the template, which can adjusted after using the template (README.md)

Contribute

This tool's repository is stored on GitHub. The README.md of the branch manual_description is also part of the TeachBooks manual as a submodule. If you'd like to contribute, you can create a fork and open a pull request on the GitHub repository. To update the README.md shown in the TeachBooks manual, create a fork and open a merge request for the GitHub repository of the manual. If you intent to clone the manual including its submodules, clone using: git clone --recurse-submodulesgit@github.com:TeachBooks/manual.git.

Template README

Remove all of the above after you've taken this template and followed the instructions. The following lines are a template for your own README

<Book title>

<description of book's content en target audience>

Contributors

  • <list authors>

Reuse content

Feel free to reuse this content or contribute to it. Please give appropriate credit, provide a link to the license, and indicate if changes were made (CC BY 4.0 License)

The website (<book_website_url>) is created using the TeachBooks Python package. To recreate it you have two options (more information in the TeachBooks manual:

  • In the GitHub interface: fork this repository, enable Github Pages from the source GitHub actions (Settings - Code and automation - Pages - Build and deployment - Source - GitHub Actions), enable workflows (Actions - I understand my workflows, go ahead and enable them) and run the call-deploy-book workflow (Actions - call-deploy-book - Run workflow - Run workflow). The website is released on the URL as shown on the workflow summary when the workflow has finished (Actions - call-deploy-book - call-deploy-book - Summary).
  • On your own computer: clone this repository, install the required packages (pip install -r requirements.txt) and build the book (teachbooks build book). The website is stored locally in book/_build/index.html.