From cf1ebcd19f778f4f8b1fb2845db3f2a0c39c4df3 Mon Sep 17 00:00:00 2001 From: "Anders H. Rebner" <anderhre@stud.ntnu.no> Date: Mon, 2 Mar 2020 18:10:34 +0100 Subject: [PATCH] La til link til autogenerert docs i README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5abde24..1798acb 100644 --- a/README.md +++ b/README.md @@ -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. -- GitLab