From 7ccaf87dfca5688f233612e1945085417decbf0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=C3=A1=C5=A1=20Havelka?= Date: Sun, 10 Jul 2022 23:38:11 +0200 Subject: [PATCH 1/3] =?UTF-8?q?Pokus=20o=20lep=C5=A1=C3=AD=20orientaci=20v?= =?UTF-8?q?=20dokumentaci?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/index.rst | 5 ++++- docs/sphinx.rst | 4 +++- docs/zapisy/zapisy.rst | 5 ++++- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 10d6016f..5613124b 100644 --- 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 `. + .. toctree:: :caption: M&M web :maxdepth: 2 + :titlesonly: vyvoj sphinx - dalsi_soubory modules/modules + dalsi_soubory zapisy/zapisy diff --git a/docs/sphinx.rst b/docs/sphinx.rst index fea2c1a7..2757ae16 100644 --- 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 diff --git a/docs/zapisy/zapisy.rst b/docs/zapisy/zapisy.rst index 1150a65c..7839449f 100644 --- a/docs/zapisy/zapisy.rst +++ b/docs/zapisy/zapisy.rst @@ -2,4 +2,7 @@ Zápisy ====== .. toctree:: - 2021-12-06-testovani_dokumentace_codereview \ No newline at end of file + :caption: Importy zápisů z Markdownu + :maxdepth: 1 + + 2021-12-06-testovani_dokumentace_codereview \ No newline at end of file From fd3df6c3443ba5c909be667d02b41189b146484d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=C3=A1=C5=A1=20Havelka?= Date: Mon, 5 Sep 2022 20:49:23 +0200 Subject: [PATCH 2/3] WIP --- docs/index.rst | 15 ++++++++++++++- docs/sphinx.rst | 2 +- docs/struktura.rst | 31 +++++++++++++++++++++++++++++++ 3 files changed, 46 insertions(+), 2 deletions(-) create mode 100644 docs/struktura.rst diff --git a/docs/index.rst b/docs/index.rst index 5613124b..1fdc4ce7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,20 @@ 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 `. +Tzv. produkce (tedy to, co vidí uživatelé) běží na ``_ (resp. +``_), 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 +``_. + +Abychom uměli web vyvíjet, musíme ho většinou nejdřív umět +:doc:`naklonovat a spustit lokálně `. + +:doc:`struktura mamwebu ` se řídí hlavně djangem, ale snažíme se +také o oddělení jednotlivých částí do :doc:`samostatných aplikací +`. + +Dokumentace (jak v ``docs/``, tak přímo v kódu) je psaná ve +:doc:`sphinxu `. .. toctree:: :caption: M&M web diff --git a/docs/sphinx.rst b/docs/sphinx.rst index 2757ae16..6a9b7a53 100644 --- a/docs/sphinx.rst +++ b/docs/sphinx.rst @@ -15,7 +15,7 @@ To je snad vše, co je potřeba vědět k dokumentaci mamwebu. Následující se 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 diff --git a/docs/struktura.rst b/docs/struktura.rst new file mode 100644 index 00000000..439e39e9 --- /dev/null +++ b/docs/struktura.rst @@ -0,0 +1,31 @@ +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í ` 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 `. + +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. From 315dc97635ba155a59910969cc0de2ddaca65b13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=C3=A1=C5=A1=20Havelka?= Date: Tue, 15 Nov 2022 13:08:20 +0100 Subject: [PATCH 3/3] =?UTF-8?q?Add:=20dal=C5=A1=C3=AD=20n=C3=A1pad=20do=20?= =?UTF-8?q?apr=C3=ADlu?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/april.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/april.rst b/docs/april.rst index 5f103357..8a479b20 100644 --- a/docs/april.rst +++ b/docs/april.rst @@ -2,3 +2,4 @@ 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 +* změnit veškerý text na oranžovo