mam/mamweb
13
1
Fork 0
Code Issues Pull requests 12 Projects Wiki Activity Actions

Pokus o lepší orientaci v dokumentaci

Browse source
This commit is contained in:
Jonas Havelka 2022-07-10 23:38:11 +02:00
parent b80e73efb9
commit 7ccaf87dfc
3 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/index.rst
View file

@ -6,14 +6,17 @@
Vítejte v dokumentaci M&Mího webu! 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:: .. toctree::
:caption: M&M web :caption: M&M web
:maxdepth: 2 :maxdepth: 2
:titlesonly:
vyvoj vyvoj
sphinx sphinx
dalsi_soubory
modules/modules modules/modules
dalsi_soubory
zapisy/zapisy zapisy/zapisy

4
docs/sphinx.rst
View file

@ -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`_ 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 .. _Návod na syntaxi rst: https://sphinx-tutorial.readthedocs.io/step-1/#sections
.. _Cheat sheet: https://sphinx-tutorial.readthedocs.io/cheatsheet/ .. _Cheat sheet: https://sphinx-tutorial.readthedocs.io/cheatsheet/
make html 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 sphinx-apidoc --module-first -o modules .. ../*/migrations --templatedir _templates -f

3
docs/zapisy/zapisy.rst
View file

@ -2,4 +2,7 @@ Zápisy
====== ======
.. toctree:: .. toctree::
:caption: Importy zápisů z Markdownu
:maxdepth: 1
2021-12-06-testovani_dokumentace_codereview 2021-12-06-testovani_dokumentace_codereview