Skip to content

Instantly share code, notes, and snippets.

@LiutongZhou

LiutongZhou/document_project.md

Last active August 18, 2022 19:52
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save LiutongZhou/0fc950e41aea6f680704de98216b41df to your computer and use it in GitHub Desktop.
Save LiutongZhou/0fc950e41aea6f680704de98216b41df to your computer and use it in GitHub Desktop.
Download ZIP
Document a Project
Raw
document_project.md

How to document a project

How to update the docs and publish to the Home Page?

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

How to generate a PDF report for the project?

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment