Compare commits
No commits in common. "f96c24a4746bc6632af5481992e1a9d4a911d61d" and "c76fcb363aeb5948f35e39ebf63399b821ee44d7" have entirely different histories.
f96c24a474
...
c76fcb363a
5 changed files with 3 additions and 56 deletions
|
@ -2,4 +2,3 @@ Aprílové nápad
|
||||||
==============
|
==============
|
||||||
|
|
||||||
* aprílový easter-egg pro řešitele - vytvořit nějakou vtipnou testovací databázi a nasadit ji místo produkce
|
* aprílový easter-egg pro řešitele - vytvořit nějakou vtipnou testovací databázi a nasadit ji místo produkce
|
||||||
* změnit veškerý text na oranžovo
|
|
||||||
|
|
|
@ -6,31 +6,15 @@
|
||||||
Vítejte v dokumentaci M&Mího webu!
|
Vítejte v dokumentaci M&Mího webu!
|
||||||
===================================
|
===================================
|
||||||
|
|
||||||
Tzv. produkce (tedy to, co vidí uživatelé) běží na `<mam.mff.cuni.cz>`_ (resp.
|
|
||||||
`<mam.matfyz.cz>`_), menu, obrázky v pozadí menu a spousta stránek (ty pouze se
|
|
||||||
statickým textem/obrázky) se mění přímo na produkci. Testovací verze běží na
|
|
||||||
`<https://mam-test.ks.matfyz.cz/>`_.
|
|
||||||
|
|
||||||
Abychom uměli web vyvíjet, musíme ho většinou nejdřív umět
|
|
||||||
:doc:`naklonovat a spustit lokálně <vyvoj>`.
|
|
||||||
|
|
||||||
:doc:`struktura mamwebu <struktura>` se řídí hlavně djangem, ale snažíme se
|
|
||||||
také o oddělení jednotlivých částí do :doc:`samostatných aplikací
|
|
||||||
<modules/modules>`.
|
|
||||||
|
|
||||||
Dokumentace (jak v ``docs/``, tak přímo v kódu) je psaná ve
|
|
||||||
:doc:`sphinxu <sphinx>`.
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:caption: M&M web
|
:caption: M&M web
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:titlesonly:
|
|
||||||
|
|
||||||
vyvoj
|
vyvoj
|
||||||
sphinx
|
sphinx
|
||||||
|
dalsi_soubory
|
||||||
skripty
|
skripty
|
||||||
modules/modules
|
modules/modules
|
||||||
dalsi_soubory
|
|
||||||
zapisy/zapisy
|
zapisy/zapisy
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -8,14 +8,12 @@ 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
|
||||||
|
|
||||||
|
|
|
@ -1,31 +0,0 @@
|
||||||
Co kde najít (mamweb + django)
|
|
||||||
==============================
|
|
||||||
|
|
||||||
Nejdůležitější aplikace z pohledu djanga je ``mamweb``. Tu totiž django pouští
|
|
||||||
a obsahuje tedy nastavení (tam se přidávají ostatní aplikace, včetně těch
|
|
||||||
importovaných z djanga, a nastavují se tam různé věci jak v djangu, tak i naše,
|
|
||||||
například složky, kam se budou věci přidané uživateli ukládat). Dále obsahuje
|
|
||||||
základní urls, udávající, „na jaké adrese co je“. A nakonec obsahuje obecné
|
|
||||||
věci jako chybové hlášky a vzhled M&M stránek (menu, patička, atd.). Aktuálně
|
|
||||||
i veškeré csv.
|
|
||||||
|
|
||||||
Další jsou pak jednotlivé aplikace (pokud něco hledáte, tak zřejmě chcete najít
|
|
||||||
tu aplikaci, která tomu odpovídá, respektive se k ní dostat přes url), za
|
|
||||||
zmínku stojí seminar, kde jsou takové ty věci, co zbyly. Plus jsou tam aktuálně
|
|
||||||
téměř všechny modely, protože je těžké je přesunout jinam.
|
|
||||||
|
|
||||||
**TLDR: Nevšímejte si složky data/ a souborů přímo v kořenové složce.**
|
|
||||||
Kromě věcí potřebných ke gitu, :doc:`ke spuštění <vyvoj>` a fukci djanga,
|
|
||||||
dalších drobností, lokální databáze a již zmíněných aplikací jsou tu ``data``,
|
|
||||||
kde je takový ten obsah webu, co by se měl dát snadno měnit (tudíž musí být v
|
|
||||||
databázi), tj. statické stránky, menu a obrázky v pozadí menu. Ten je třeba
|
|
||||||
měnit hlavně na produkci a sekundárně tady (může to dělat i newebař a nechcete
|
|
||||||
přepsat jeho práci). Vše, co nejsou aplikace je popsáno :doc:`tady <dalsi_soubory>`.
|
|
||||||
|
|
||||||
Základy djanga
|
|
||||||
--------------
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
mamweb je psaný téměř čistě v djangu. Což znamená, že to „co je vidět na stránkách“
|
|
||||||
jsou views.
|
|
|
@ -2,7 +2,4 @@ Zápisy
|
||||||
======
|
======
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:caption: Importy zápisů z Markdownu
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
2021-12-06-testovani_dokumentace_codereview
|
2021-12-06-testovani_dokumentace_codereview
|
Loading…
Reference in a new issue