LiutongZhou/document_project.md

Last active August 18, 2022 19:52

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/LiutongZhou/0fc950e41aea6f680704de98216b41df.js"></script>
Save LiutongZhou/0fc950e41aea6f680704de98216b41df to your computer and use it in GitHub Desktop.

Document a Project

Raw

How to document a project

Prerequisites

One-time installation of dependencies

python3 -m pip install -U jupyter-book ghp-import

You simply modify the markdown files in the docs folder and run

jb build docs && ghp-import -n -p -f docs/_build/html

Prerequisites

You need to have pdflatex installed. If not, you can install texlive

Run

jb build docs/ --builder pdflatex

The book.pdf will be generated in the docs/_build/latex folder.