diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..e85cc51 --- /dev/null +++ b/doc/README.md @@ -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ę. \ No newline at end of file