13. ReST and Sphinx documentation

13.1. reStructuredText vs. Markdown

13.2. Format reStructuredText

13.2.1. Po co?

13.2.2. Paragrafy

  • newline

13.2.3. Nagłówki

  • Tytuł

  • Nagłówek pierwszego poziomu

  • Nagłówek drugiego poziomu

  • Nagłówek trzeciego poziomu

  • Nagłówek czwartego poziomu (czy stosować?)

13.2.4. Odnośniki

  • Wewnątrz dokumentu

  • numref

  • na zewnątrz dokumentu

13.2.5. Obrazki i media

  • figure (scale, name, align, podpisy pod obrazkami)

13.2.6. Specjalne wstawki

  • .. todo::

13.2.7. Listingi kodu

  • Osadzone

  • Z plików zewnętrznych

13.2.8. TODO

13.2.9. Listy

  • listy nieuporządkowane

  • listy numerowane

  • jednopoziomowe i zagnieżdżone

  • listy mieszane

13.2.10. Tabele

  • Table

  • List Table

  • CSV Table

13.2.11. Cytowanie

  • cite

  • bibtex

13.3. Sphinx

13.3.1. Zależności

  • requirements.txt

    # Minimalne wymaganie
    sphinx==1.8.*
    
    # Theme Read the Docs
    sphinx_rtd_theme
    
    # System cytowania i parsowanie bibtex
    sphinxcontrib-bibtex
    
    # Jeżeli chcemy generować slajdy RevealJS
    sphinxjp.themes.revealjs
    

13.3.2. Config

  • Wersja na podstawie hasha git

13.3.3. Dobre praktyki

  • podział na rozdziały

  • rozkład katalogów

  • listingi kodu

  • zdjęcia

  • dane w tabelkach CSV

  • konwencja nazewnicza plików

  • konwencja nazewnicza figure, csv-table, literalinclude

13.3.4. Generowanie dokumentacji

  • Table of Contents

13.3.5. toctree

13.3.6. Automatyczne odpalanie doctestów do listingów kodu

13.3.7. Osadzanie LaTeX

13.3.8. Budowanie

  • make html

  • make singlehtml

  • make pdf

  • generowanie Word (docx) -> pandoc

13.4. Read the docs

13.5. Assignments

13.5.1. Dokumentacja

  1. Za pomocą sphinx-quickstart stwórz dokumentację.

  2. Zmień theme na sphinx_rtd_theme

  3. Dokument zatytułuj “Szkolenie z Pythona”

  4. Stwórz nagłówek pierwszego poziomu “Obrazki i teksty” i w nim osadź obrazek jako figure, wraz tekstem opisującym, obrazek ma być połowy wielkości i wycentrowany, nazwany

  5. Stwórz nagłówek pierwszego poziomu “Lorem Ipsum” i wklej tekst lorem ipsum do dokumentacji.

  6. W tekście lorem ipsum wstaw numref do obrazka

  7. Stwórz nagłówek pierwszego poziomu i zamieść tabelę Irysów na podstawie danych Iris Dataset

  8. Stwórz nagłówek pierwszego poziomu “Listingi kodu” i osadź dwa swoje skrypty z poprzednich zadań:

    • książka adresowa jako literalinclude w nagłówku drugiego poziomu “Książka Adresowa”

    • prosty skrypt jako code-block w nagłówku drugiego poziomu “Pozostałe przykłady”

    • które podejście jest lepsze?

  9. Tekst lorem ipsum oznacz jako cytowanie cycerona wykorzystując bibtext