s444409/DSZI_Survival
s444409/DSZI_Survival
2
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added readme

Browse Source
This commit is contained in:
Marcin Kostrzewski 2020-05-14 15:00:31 +02:00
parent 1610f9c0da
commit 154dbaffaa
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/README.md Normal file
View File

@ -0,0 +1,23 @@
# Sphinx autodoc
Pliki źródłowe do generowania automatycznej dokumentacji kodu za pomocą biblioteki Sphinx.
## Wymagania:
```
Python 3.x
sphinx: 4.x
```
## Ręczne budowanie dokumentacji
Windows:
```shell script
make.bat html
```
Linux/MacOS:
```shell script
make html
```
## Automatyczne budowanie dokumentacji w PyCharm
W PyCharmie tworzymy nową konfigurację Python docs -> Sphinx. Jako parametr "input" uswiatiamy ścieżkę do tego folderu,
a output wskazujemy tam, gdzie chcemy otrzymać gotową dokumentację.