Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gucio321/ft2zxcxvx
Sphinx Template for Physics Laboratory (FT2) FIS AGH.
https://github.com/gucio321/ft2zxcxvx
Last synced: 7 days ago
JSON representation
Sphinx Template for Physics Laboratory (FT2) FIS AGH.
- Host: GitHub
- URL: https://github.com/gucio321/ft2zxcxvx
- Owner: gucio321
- Created: 2024-02-28T15:50:16.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-06-03T16:51:26.000Z (5 months ago)
- Last Synced: 2024-06-03T19:37:26.516Z (5 months ago)
- Language: Python
- Homepage: https://github.com/FT2z7
- Size: 233 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> **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**
# Description
Template for Physics Labs reports on AGH. -- Szablon sprawozdań z Laboratorium Fizycznego AGH.
## Usage
1. Clone this repository or create your own from the template.
2. Edit conf.py and/or other files (I'll put list here). The variables you may want to use are on top of `conf.py` (title/author, e.t.c.)
3. (Only first time) Generate virtual enviroument `python3 -m virtualenv venv` and activate it `source venv/bin/activate`
4. Edit `index.md` and/or other files
5. Use makefile to generate project (`make html` / `make latexpdf`)
Pre requirements
- On fedora you need to install this:
```sh
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:
```sh
sudo apt install -y latexmk texlive texlive-fonts-extra texlive-full texlive-lang-polish
```
- on other distros: Generally you need to find the following:
* `pdflatex` command
* 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](https://pypi.org/project/sphinxcontrib-plot/)
## Resources
- [AGH - WFIiS Title Pag template](https://www.overleaf.com/latex/templates/praca-dyplomowa/kbwcrcmczypy)