History

Marcin Kostrzewski 31811782fb Now displays game's __init__		2020-05-14 16:24:52 +02:00
..
src	Now displays game's __init__	2020-05-14 16:24:52 +02:00
conf.py	Added sphinx documentation generator	2020-05-14 14:40:53 +02:00
index.rst	Prettier doc	2020-05-14 15:20:37 +02:00
make.bat	Added sphinx documentation generator	2020-05-14 14:40:53 +02:00
Makefile	Added sphinx documentation generator	2020-05-14 14:40:53 +02:00
README.md	Fixed code highlighting	2020-05-14 15:01:43 +02:00

README.md

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:

make.bat html

Linux/MacOS:

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ę.