WIP
This commit is contained in:
		
							parent
							
								
									7ccaf87dfc
								
							
						
					
					
						commit
						fd3df6c344
					
				
					 3 changed files with 46 additions and 2 deletions
				
			
		|  | @ -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 <vyvoj>`. | ||||
| 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:: | ||||
|    :caption: M&M web | ||||
|  |  | |||
|  | @ -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 | ||||
| 
 | ||||
|  |  | |||
							
								
								
									
										31
									
								
								docs/struktura.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										31
									
								
								docs/struktura.rst
									
									
									
									
									
										Normal file
									
								
							|  | @ -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í <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. | ||||
		Loading…
	
		Reference in a new issue