Dodanie dokumentacji Sphinx

[FWalkowicz]

Opis

Stworzenie profesjonalnej dokumentacji z naszego projektu, która będzie zawierała opis działania, opis wykorzystanych metod oraz kodu. Celem stworzenia takiej dokumentacji jest:

• łatwiejsze wprowadzenie do projektu nowych osób
• poprawna klarowności i zrozumiałości
• ułatwienie w utrzymaniu projektu

Zadania

Wstęp i wprowadzenie:

• Opis projektu: krótki opis projektu, jego cele i kontekst.
• Instrukcje dotyczące instalacji: jak zainstalować i skonfigurować projekt.

Dokumentacja techniczna:

• Opis metod użytych w projekcie
• Opis narzędzi wykorzystanych w projekcie

Dokumentacja kodu:

• Opis klas
• Opis funkcji
• Przykładu użycia

Plany na przyszłość

Co wykorzystuje

• sphinx