Pokus o lepší orientaci v dokumentaci

2 years ago · 7ccaf87dfc
3 changed files with 11 additions and 3 deletions
--- a/docs/index.rst
+++ b/docs/index.rst
@ -6,14 +6,17 @@
 Vítejte v dokumentaci M&Mího webu!
 ===================================

+Abychom uměli web vyvíjet, musíme ho nejdřív umět :doc:`naklonovat a spustit <vyvoj>`.
+
 .. toctree::
   :caption: M&M web
   :maxdepth: 2
+   :titlesonly:

   vyvoj
   sphinx
-   dalsi_soubory
   modules/modules
+   dalsi_soubory
   zapisy/zapisy


--- a/docs/sphinx.rst
+++ b/docs/sphinx.rst
@ -8,12 +8,14 @@ Jinak všechny rst, co jsou ve složce ``doc`` a jejích podsložkách nezačín

 Sphinx se píše v rst: `Návod na syntaxi rst`_ `Cheat sheet`_

+To je snad vše, co je potřeba vědět k dokumentaci mamwebu. Následující sekce jsou o tom, co jsem provedl Sphinxu, aby to fungovalo:
+
 .. _Návod na syntaxi rst: https://sphinx-tutorial.readthedocs.io/step-1/#sections
 .. _Cheat sheet: https://sphinx-tutorial.readthedocs.io/cheatsheet/

 make html
 ---------
-Make html dělá následující: Vygenerují se rst soubory do modules z pythoní dokumentace pomocí::
+`make html` dělá následující: Vygenerují se rst soubory do modules z pythoní dokumentace pomocí::

    sphinx-apidoc --module-first -o modules .. ../*/migrations --templatedir _templates -f

--- a/docs/zapisy/zapisy.rst
+++ b/docs/zapisy/zapisy.rst
@ -2,4 +2,7 @@ Zápisy
 ======

 .. toctree::
-    2021-12-06-testovani_dokumentace_codereview
+   :caption: Importy zápisů z Markdownu
+   :maxdepth: 1
+
+   2021-12-06-testovani_dokumentace_codereview