Skip to content
Snippets Groups Projects
Commit cf1ebcd1 authored by Anders H. Rebner's avatar Anders H. Rebner
Browse files

La til link til autogenerert docs i README

parent 3193f00c
No related branches found
No related tags found
No related merge requests found
Pipeline #71976 passed
......@@ -31,7 +31,7 @@ deactivate
Sjekk av kodekvalitet gjøres med scriptet "CodeQualityCheck" i script-mappa, og er skrevet i Powershell(.ps1) og Bash(.sh). Scriptet kjører Pylint og Flake8 med tilhørende konfigurasjonsfiler, Pydocstyle med numpy-konvensjon og Bandit på Python-filer.
Scriptet godtar kommandolinjeargumenter: .py-fil(er), mappe(r ) eller en blanding av disse. Uten argumenter vil scriptet sjekke alle .py-filer.
Scriptet godtar kommandolinjeargumenter: .py-fil(er), mappe(r) eller en blanding av disse. Uten argumenter vil scriptet sjekke alle .py-filer.
Terminal kjøres fra root. Sjekk:
......@@ -39,7 +39,7 @@ Terminal kjøres fra root. Sjekk:
* Spesifikk(e) .py: `.\scripts\CodeQualityCheck.ps1 filEn.py filTo.py`
* Alle .py i mappe(r ): `.\scripts\CodeQualityCheck.ps1 mappeEn mappeTo`
* Alle .py i mappe(r): `.\scripts\CodeQualityCheck.ps1 mappeEn mappeTo`
* Blanding: `.\scripts\CodeQualityCheck.ps1 mappeEn mappeTo\fil.py`
......@@ -59,6 +59,8 @@ Gjøres med pdoc3:
* Uten kildekode: `pdoc3 --html --config show_source_code=False --output-dir .\docs\ .\soitool\main.py`
Autogenerert docs: http://bachelor-paa-bittet.pages.stud.idi.ntnu.no/soitool/
## Om `Dockerfile`
Docker image som brukes i `.gitlab-ci.yml` er bygget med filen `Dockerfile` og er lastet opp som `morkolai/soitool-ci`. Docker image inneholder alle avhengigheter til prosjektet. Følgende prosedyre brukes for å oppdatere image. Dette må gjøres når `requirements.txt` endrer seg.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment