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

Instruksjoner for generering av kodedokumentasjon i README

parent 826eb1f6
No related branches found
No related tags found
No related merge requests found
......@@ -33,9 +33,9 @@ Sjekk av kodekvalitet gjøres med scriptet "CodeQualityCheck" i script-mappa, og
Terminal kjøres fra root:
* Sjekk alle .py: `scripts/CodeQualityCheck.ps1` eller `scripts/CodeQualityCheck.sh`
* Sjekk alle .py: `.\scripts\CodeQualityCheck.ps1` eller `./scripts/CodeQualityCheck.sh`
* Sekk spesifikk(e) .py: `scripts/CodeQualityCheck.ps1 filEn.py filTo.py`
* Sekk spesifikk(e) .py: `.\scripts\CodeQualityCheck.ps1 filEn.py filTo.py`
## Testing
......@@ -44,3 +44,11 @@ Tester er skrevet med `unittest` modulen, og ligger i mappen `test`.
* For å kjøre alle tester: `python -m unittest`
* For å kjøre en enkelt test modul (fil i `test` mappen): `python -m unittest test.<navnet_til_modulen>`
* For å kjøre en enkelt test metode (fil i `test` mappen): `python -m unittest test.<navnet_til_modulen>.<navnet til klassen>.<navnet til metoden>`
## Generering av kodedokumentasjon
Gjøres med pdoc3:
* `pdoc3 --html --output-dir .\docs .\soitool\main.py`
* Uten kildekode: `pdoc3 --html --config show_source_code=False --output-dir .\docs\ .\soitool\main.py`
\ No newline at end of file
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