NOTE: to use pdf build GitHub action, you might need to enable Write Access for our workflow. Navigate Settings -> Actions -> General and change Workflow Permissions to Read and Write permissions
Template for Physics Labs reports on AGH. -- Szablon sprawozdań z Laboratorium Fizycznego AGH.
- Clone this repository or create your own from the template.
- Edit
conf.pyand/or other files (I'll put list here). The variables you may want to use are on top ofconf.py(title/author, e.t.c.) - (Only first time) Generate virtual enviroument
uv venv - Activate venv
source .venv/bin/activate - (Only first time) Install dependencies
uv sync - Edit
assets/document.mdand/or other files - Use makefile to generate project (
make html/make latexpdf)
Pre requirements
- On fedora you need to install this:
dnf install -y latexmk texlive-cmap texlive-collection-fontsrecommended texlive-fncychap texlive-wrapfig texlive-capt-of texlive-framed texlive-upquote texlive-needspace texlive-tabulary texlive-parskip texlive-oberdiek texlive-cancel texlive-hyphen-polish texlive-pict2e texlive-ellipse.noarch- on
apt-based linux:
sudo apt install -y latexmk texlive texlive-fonts-extra texlive-full texlive-lang-polish- on
pacman-based linux:
sudo pacman -S texlive-basic texlive-bibtexextra texlive-bin texlive-binextra texlive-fontsextra texlive-fontsrecommended texlive-langpolish texlive-latex texlive-latexextra texlive-latexrecommended texlive-luatex texlive-pictures texlive-xetex[!note] Turns out that when
texlive-fontsextrais not installed, the fancy icons next to admonition blocks are not rendered.
-
on other distros: Generally you need to find the following:
pdflatexcommand- something like
texlive-full - polish babel version (e.g. search for
texlive*polish*)
-
On windows: STOP USEING WINDOWS. Ok, seriously speaking: check out the previous point - you need same setup.
Available technologies:
- Markdown files support
- Latex formulas
- Plots check here for more info