Opracowanie dokumentacji [RtD]

Po zapoznaniu się z poniższymi krokami wykonaj zadanie stosując się do wskazówek i poleceń z odnosnika Tutorial Read the Docs.

Realizacja: dla tego zadania należy przejść poniższą procedurę

1. Załóż repozytorium na platformie GIThub (Gh) używając szablonu ReatTheDocs (RtD) odnośnika

2. Zaloguj się na platformę RtD używając konta z platformy Gh

3. Autoryzuj konto z platformy RtD do dostępu do konta Gh i jego repozytoriów (nadaj uprawnienia i potwierdź e-mail)

4. Wybierz Repozytorium do importu z platformy Gh dla którego chcesz stworzyć Dokumentację

5. Uzupełnij informacje na platformie RtD o Projekcie pobranym z Repozytorium

6. Poczekaj na stworzenie Dokumentacji na podstawie importowanego Repozytorium (może to potrwać jakiś czas, w zależności od wielkości projektu)

Realizacja tego zadania polega na wizualnym nabyciu wiedzy - podjęcie działań (np. wykonania notatek) opisane w Pkt. 3 Wynotuj składnię elementów dokumentu.

• Wejdź na stronę główną RtD Tutorial i przejżyj ją z góry na dół

• Wejdź na stronę RtD Tutorial z poziomu platformy Gh (wyświetl wersję RAW) i porównaj ze stroną w wersji HTML (w/w pkt. A)
  Drugi odnośnik Tutorial Read the Docs - wersja źródła na GIThub

Realizacja zadania polega na przegotowaniu dokumentu/wykonaniu notatek.

Wynotuj składnię następujących elementów:

• Nagłówki tekstowe (poziomy 1-4)

• Akapit tekstowy (treść)

• Akapit informacyjny (Note, Tip)

• Fragment kodu (liniowy, blokowy)

• Odnośnik (lokalny RtD, zewnętrzny-inny serwis)

• Listy (numerowana, wypunktowana, definicji)

• Obraz (z alternatywnym tekstem oraz podpisem)

• Tabela (jeżeli istnieje)

Zapoznaj się z poniższymi punktami oraz wskazanymi plikami, porównaj, przeanalizuj i zastosuj zebraną wiedzę do stworzenia własnej dokumentacji.

Realizacja zadania polega na stworzeniu dokumentacji złożonej z plików: Strona główna, Spis treści, czyli Table of Content oraz dwóch podstron (Pkt3. Wynotuj składnię elementów dokumentu oraz O Autorze).

• Na platformie GitHub załóż w repozytorium katalog /docs

• Stwórz w w/w katalog plik index.rst i uzupełnij go jako Stronę główną przykładowego projektu

• Następnie stwórz w nim spis treści (TOC: .. toctree::)

• Na platformie RtD przebuduj projekt (dokumentację)

• Zweryfikuj w widoku dokumentcji, czy znajduje się Spis treści ze stroną główną oraz dwiema podstronami