You will need to install the requirements:
python -m pip install -r requirements.txtYou could build the book as HTML using jupyter-book:
python -m jupyter book build .However because we need OG metadata, the book is built using sphinx directly:
sphinx-build . ./_build/html -b htmlThis is in fact what the GitHub workflow does.
The
conf.pywas generated by runningjupyter-book config sphinx .and adding thesphinxext.opengraphextension.
To build the book as PDF install the pyppeteer package and execute the build command:
python -m pip install pyppeteer
python -m jupyter book build --builder pdfhtml .To build as LaTeX you will need to install the required packages and then run the build command:
sudo apt-get install texlive-latex-extra texlive-fonts-extra texlive-xetex latexmk
python -m jupyter book build . --builder pdflatex
# OR python -m jupyter book build . --builder latex if you only want the LaTeX filePlease adhere to https://www.conventionalcommits.org/en/v1.0.0/ when writing commit messages.
If you are working on a particular chapter the scope should always be of the form C1. For example if you make some minor improvements in chapter 1, your commit message should look like this:
chore(C1): minor improvements
Branch names should be lisp-case and should start with the chapter name the feature of fix applies to.
For example if you fix a typo in Chapter 1, the branch name should be c-01-fix-typo.
Don't forget to clear all notebooks before creating a PR, otherwise your code cell outputs will be included in the PR, which you don't want:
find src -type f -name "*.ipynb" -exec jupyter nbconvert --clear-output --inplace {} \;