From 59d9589162a400b2f9bbbe83ce942acc6a6e93ac Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jon=C3=A1=C5=A1=20Havelka?= <jonas.havelka@volny.cz>
Date: Mon, 31 Jul 2023 17:32:25 +0200
Subject: [PATCH] =?UTF-8?q?Generick=C3=A9=20dokumentace=20djangovsk=C3=BDc?=
 =?UTF-8?q?h=20soubor=C5=AF=20to=20chce=20=C5=99e=C5=A1it=20jinak=E2=80=A6?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 api/apps.py                 |  3 ---
 api/urls.py                 | 12 ------------
 api/views/__init__.py       |  5 -----
 galerie/urls.py             |  9 ---------
 header_fotky/admin.py       | 13 +------------
 header_fotky/apps.py        |  3 ---
 korektury/admin.py          | 10 ----------
 korektury/urls.py           |  8 --------
 korektury/views.py          |  5 -----
 mamweb/urls.py              | 16 ----------------
 odevzdavatko/admin.py       |  6 ------
 odevzdavatko/apps.py        |  3 ---
 odevzdavatko/urls.py        | 14 --------------
 personalni/apps.py          |  3 ---
 personalni/urls.py          | 14 --------------
 prednasky/urls.py           |  9 ---------
 seminar/urls.py             | 31 -------------------------------
 soustredeni/apps.py         |  3 ---
 treenode/apps.py            |  3 ---
 treenode/urls.py            |  5 -----
 various/apps.py             |  3 ---
 various/autentizace/urls.py | 13 -------------
 vysledkovky/apps.py         |  3 ---
 23 files changed, 1 insertion(+), 193 deletions(-)

diff --git a/api/apps.py b/api/apps.py
index 6a2bdbc4..d87006dd 100644
--- a/api/apps.py
+++ b/api/apps.py
@@ -1,6 +1,3 @@
-"""
-Soubor sloužící k pojmenování a jiným nastavením djangovské aplikace.
-"""
 from django.apps import AppConfig
 
 
diff --git a/api/urls.py b/api/urls.py
index a3b5a4aa..9ff38424 100644
--- a/api/urls.py
+++ b/api/urls.py
@@ -1,15 +1,3 @@
-"""
-Soubor sloužící jako „router“, tj. zde se definují url adresy a na co ukazují:
-
-- ``api/expor/skoly/`` (export_skoly) :func:`~api.views.exports.exportSkolView`
-- ``api/autocomplete/skola/`` (autocomplete_skola) :class:`~api.views.autocomplete.SkolaAutocomplete`
-- ``api/autocomplete/resitel/`` (autocomplete_resitel) :class:`~api.views.autocomplete.ResitelAutocomplete`
-- ``api/autocomplete/problem/odevzdatelny`` (autocomplete_problem_odevzdatelny) :class:`~api.views.autocomplete.OdevzdatelnyProblemAutocomplete`
-
-Na autocomplete v3 čeká:
-
-- ``autocomplete/organizatori/`` (seminar_autocomplete_organizator) :class:`~api.views.autocomplete.OrganizatorAutocomplete`
-"""
 from django.urls import path
 from . import views
 from seminar.utils import org_required
diff --git a/api/views/__init__.py b/api/views/__init__.py
index 13ce91ba..fc00554e 100644
--- a/api/views/__init__.py
+++ b/api/views/__init__.py
@@ -1,7 +1,2 @@
-"""
-Soubory sloužící k deklaraci jednotlivých „views“ (nejčastěji funkce beroucí request
-a vracející :func:`django.shortcuts.render` respektive nějakou response, nebo
-třídy většinou rozšiřující nějakou třídu z :mod:`django.views.generic`)
-"""
 from .autocomplete import *
 from .exports import *
diff --git a/galerie/urls.py b/galerie/urls.py
index 2e311cd8..32824248 100644
--- a/galerie/urls.py
+++ b/galerie/urls.py
@@ -1,12 +1,3 @@
-"""
-Soubor sloužící jako „router“, tj. zde se definují url adresy a na co ukazují:
-
-- ``<int:pk>/`` :func:`~galerie.views.nahled`
-- ``<int:pk>/<int:fotka>/`` :func:`~galerie.views.detail`
-- ``<int:galerie>/new/`` :func:`~galerie.views.new_galerie`
-- ``<int:galerie>/plus/<int:subgalerie>/`` :func:`~galerie.views.plus_galerie`
-- ``<int:galerie>/minus/<int:subgalerie>/`` :func:`~galerie.views.minus_galerie`
-"""
 from django.urls import path
 from seminar.utils import org_required
 from . import views
diff --git a/header_fotky/admin.py b/header_fotky/admin.py
index b939541b..cfcb4d48 100644
--- a/header_fotky/admin.py
+++ b/header_fotky/admin.py
@@ -1,14 +1,3 @@
-"""
-Soubor sloužící k definici toho, co bude v adminu. Většinou pouhým zavoláním
-funkce :func:`django.contrib.admin.site.register`, v případě, že chceme něco
-upravit, tak jako třída rozšiřující :class:`django.contrib.admin.ModelAdmin`
-s dekorátorem :func:`django.contrib.admin.register`.
-
-Zde se definuje admin pro:
-
-- :class:`~header_fotky.models.FotkaHeader`
-- :class:`~header_fotky.models.FotkaUrlVazba`
-"""
 from django.contrib import admin
 from django.contrib.admin import ModelAdmin
 import header_fotky.models as m
@@ -22,4 +11,4 @@ class FotkaPozadiAdmin(ModelAdmin):
     readonly_fields = ['cas']
 
 admin.site.register(m.FotkaHeader, FotkaPozadiAdmin)
-admin.site.register(m.FotkaUrlVazba)
\ No newline at end of file
+admin.site.register(m.FotkaUrlVazba)
diff --git a/header_fotky/apps.py b/header_fotky/apps.py
index 13f93ed4..084aa955 100644
--- a/header_fotky/apps.py
+++ b/header_fotky/apps.py
@@ -1,6 +1,3 @@
-"""
-Soubor sloužící k pojmenování a jiným nastavením djangovské aplikace.
-"""
 from django.apps import AppConfig
 
 
diff --git a/korektury/admin.py b/korektury/admin.py
index 5f92c542..881a951c 100644
--- a/korektury/admin.py
+++ b/korektury/admin.py
@@ -1,13 +1,3 @@
-"""
-Soubor sloužící k definici toho, co bude v adminu. Většinou pouhým zavoláním
-funkce :func:`django.contrib.admin.site.register`, v případě, že chceme něco
-upravit, tak jako třída rozšiřující :class:`django.contrib.admin.ModelAdmin`
-s dekorátorem :func:`django.contrib.admin.register`.
-
-Zde se definuje admin pro:
-
-- :class:`korektury.models.KorekturovanePDF`
-"""
 from django.contrib import admin
 from reversion.admin import VersionAdmin
 from korektury.models import KorekturovanePDF
diff --git a/korektury/urls.py b/korektury/urls.py
index 96eb4dd4..dcd1d965 100644
--- a/korektury/urls.py
+++ b/korektury/urls.py
@@ -1,11 +1,3 @@
-"""
-Soubor sloužící jako „router“, tj. zde se definují url adresy a na co ukazují:
-
-- ``korektury/`` (korektury_list) :class:`~korektury.views.KorekturySeskupeneListView`
-- ``korektury/neseskupene/`` (korektury_neseskupene_list) :class:`~korektury.views.KorekturyAktualniListView`
-- ``korektury/zastarale/`` (korektury_stare_list) :class:`~korektury.views.KorekturyZastaraleListView`
-- ``korektury/<int:pdf>/`` (korektury) :class:`~korektury.views.KorekturyView`
-"""
 from django.urls import path
 from seminar.utils import org_required
 from . import views
diff --git a/korektury/views.py b/korektury/views.py
index 564e1331..3b34c654 100644
--- a/korektury/views.py
+++ b/korektury/views.py
@@ -1,8 +1,3 @@
-"""
-Soubor sloužící k deklaraci jednotlivých „views“ (nejčastěji funkce beroucí request
-a vracející :func:`django.shortcuts.render` respektive nějakou response, nebo
-třídy většinou rozšiřující nějakou třídu z :mod:`django.views.generic`)
-"""
 from django.shortcuts import get_object_or_404, render
 from django.views import generic
 from django.utils.translation import ugettext as _
diff --git a/mamweb/urls.py b/mamweb/urls.py
index 680ab621..016bc673 100644
--- a/mamweb/urls.py
+++ b/mamweb/urls.py
@@ -1,19 +1,3 @@
-"""
-Soubor sloužící jako základní „router“, tj. zde se includují veškeré ostatní urls:
-
-- ``admin/`` :mod:`django.contrib.admin.site.urls`
-- ``ckeditor/`` :mod:`ckeditor_uploader.urls`
-- :mod:`seminar.urls`
-- :mod:`odevzdavatko.urls`
-- :mod:`korektury.urls`
-- :mod:`prednasky.urls`
-- :mod:`soustredeni.urls`
-- :mod:`personalni.urls`
-- :mod:`various.autentizace.urls`
-- :mod:`api.urls`
-- :mod:`treenode.urls`
-- ``comments_dj/`` :mod:`django_comments.urls`
-"""
 from django.urls import path, include
 from django.contrib.staticfiles.urls import staticfiles_urlpatterns
 from django.contrib import admin
diff --git a/odevzdavatko/admin.py b/odevzdavatko/admin.py
index 168beab1..6048eb36 100644
--- a/odevzdavatko/admin.py
+++ b/odevzdavatko/admin.py
@@ -1,9 +1,3 @@
-"""
-Soubor sloužící k definici toho, co bude v adminu. Většinou pouhým zavoláním
-funkce :func:`django.contrib.admin.site.register`, v případě, že chceme něco
-upravit, tak jako třída rozšiřující :class:`django.contrib.admin.ModelAdmin`
-s dekorátorem :func:`django.contrib.admin.register`.
-"""
 from django.contrib import admin
 from django_reverse_admin import ReverseModelAdmin
 import seminar.models as m
diff --git a/odevzdavatko/apps.py b/odevzdavatko/apps.py
index 95811247..507c284f 100644
--- a/odevzdavatko/apps.py
+++ b/odevzdavatko/apps.py
@@ -1,6 +1,3 @@
-"""
-Soubor sloužící k pojmenování a jiným nastavením djangovské aplikace.
-"""
 from django.apps import AppConfig
 
 
diff --git a/odevzdavatko/urls.py b/odevzdavatko/urls.py
index 6b021f2e..e41b9c14 100644
--- a/odevzdavatko/urls.py
+++ b/odevzdavatko/urls.py
@@ -1,17 +1,3 @@
-"""
-Soubor sloužící jako „router“, tj. zde se definují url adresy a na co ukazují:
-
-- ``org/add_solution`` (seminar_vloz_reseni) :class:`~odevzdavatko.views.PosliReseniView`
-- ``resitel/nahraj_reseni`` (seminar_nahraj_reseni) :class:`~odevzdavatko.views.NahrajReseniView`
-- ``resitel/odevzdana_reseni/`` (seminar_resitel_odevzdana_reseni) :class:`~odevzdavatko.views.PrehledOdevzdanychReseni`
-- ``org/reseni/`` (odevzdavatko_tabulka) :class:`~odevzdavatko.views.TabulkaOdevzdanychReseniView`
-- ``org/reseni/rocnik/<int:rocnik>/`` (odevzdavatko_tabulka) :class:`~odevzdavatko.views.TabulkaOdevzdanychReseniView`
-- ``org/reseni/<int:problem>/<int:resitel>/`` (odevzdavatko_reseni_resitele_k_problemu) :class:`~odevzdavatko.views.ReseniProblemuView`
-- ``org/reseni/<int:pk>/`` (odevzdavatko_detail_reseni) :func:`~seminar.utils.viewMethodSwitch` + :class:`~odevzdavatko.views.DetailReseniView` + :func:`~odevzdavatko.views.hodnoceniReseniView`
-- ``org/reseni/all`` :class:`~odevzdavatko.views.SeznamReseniView`
-- ``org/reseni/akt`` :class:`~odevzdavatko.views.TabulkaOdevzdanychReseniView`
-- ``resitel/reseni/<int:pk>`` (odevzdavatko_resitel_reseni) :class:`~odevzdavatko.views.ResitelReseniView`
-"""
 from django.urls import path
 
 from seminar.utils import org_required, resitel_required, viewMethodSwitch, \
diff --git a/personalni/apps.py b/personalni/apps.py
index 47ba22cc..359f220c 100644
--- a/personalni/apps.py
+++ b/personalni/apps.py
@@ -1,6 +1,3 @@
-"""
-Soubor sloužící k pojmenování a jiným nastavením djangovské aplikace.
-"""
 from django.apps import AppConfig
 
 
diff --git a/personalni/urls.py b/personalni/urls.py
index cbcdb035..73a6f720 100644
--- a/personalni/urls.py
+++ b/personalni/urls.py
@@ -1,17 +1,3 @@
-"""
-Soubor sloužící jako „router“, tj. zde se definují url adresy a na co ukazují:
-
-- ``org/add_solution`` (seminar_vloz_reseni) :class:`~odevzdavatko.views.PosliReseniView`
-- ``resitel/nahraj_reseni`` (seminar_nahraj_reseni) :class:`~odevzdavatko.views.NahrajReseniView`
-- ``resitel/odevzdana_reseni/`` (seminar_resitel_odevzdana_reseni) :class:`~odevzdavatko.views.PrehledOdevzdanychReseni`
-- ``org/reseni/`` (odevzdavatko_tabulka) :class:`~odevzdavatko.views.TabulkaOdevzdanychReseniView`
-- ``org/reseni/rocnik/<int:rocnik>/`` (odevzdavatko_tabulka) :class:`~odevzdavatko.views.TabulkaOdevzdanychReseniView`
-- ``org/reseni/<int:problem>/<int:resitel>/`` (odevzdavatko_reseni_resitele_k_problemu) :class:`~odevzdavatko.views.ReseniProblemuView`
-- ``org/reseni/<int:pk>/`` (odevzdavatko_detail_reseni) :func:`~seminar.utils.viewMethodSwitch` + :class:`~odevzdavatko.views.DetailReseniView` + :func:`~odevzdavatko.views.hodnoceniReseniView`
-- ``org/reseni/all`` :class:`~odevzdavatko.views.SeznamReseniView`
-- ``org/reseni/akt`` :class:`~odevzdavatko.views.TabulkaOdevzdanychReseniView`
-- ``resitel/reseni/<int:pk>`` (odevzdavatko_resitel_reseni) :class:`~odevzdavatko.views.ResitelReseniView`
-"""
 from django.urls import path
 from django.contrib.auth.decorators import login_required
 from . import views
diff --git a/prednasky/urls.py b/prednasky/urls.py
index d0e7a703..6b455163 100644
--- a/prednasky/urls.py
+++ b/prednasky/urls.py
@@ -1,12 +1,3 @@
-"""
-Soubor sloužící jako „router“, tj. zde se definují url adresy a na co ukazují:
-
-- ``prednasky/`` :func:`~prednasky.views.newPrednaska`
-- ``prednasky/hotovo`` :func:`~prednasky.views.Prednaska_hotovo`
-- ``prednasky/metaseznam_prednasek`` (metaseznam-list) :class:`~prednasky.views.MetaSeznamListView`
-- ``prednasky/seznam_prednasek/<int:seznam>/export`` (seznam-export) :func:`~prednasky.views.SeznamExportView`
-- ``prednasky/seznam_prednasek/<int:seznam>/`` (seznam-list) :class:`~prednasky.views.SeznamListView`
-"""
 from django.urls import path
 from seminar.utils import org_required, resitel_or_org_required
 from . import views
diff --git a/seminar/urls.py b/seminar/urls.py
index f6f2e2fb..f740e6a4 100644
--- a/seminar/urls.py
+++ b/seminar/urls.py
@@ -1,34 +1,3 @@
-"""
-Soubor sloužící jako „router“, tj. zde se definují url adresy a na co ukazují:
-
-- Organizátoři
-	- ``o-nas/organizatori/`` (organizatori) :class:`~seminar.views.views_all.CojemamOrganizatoriView`
-	- ``o-nas/organizatori/organizovali/`` (stari_organizatori) :class:`~seminar.views.views_all.CojemamOrganizatoriStariView`
-- Archiv
-	- ``archiv/rocniky/`` (seminar_archiv_rocniky) :class:`~seminar.views.views_all.ArchivView`
-	- ``archiv/temata/`` (seminar_archiv_temata) :class:`~seminar.views.views_all.ArchivTemataView`
-	- ``rocnik/<int:rocnik>/`` (seminar_rocnik) :class:`~seminar.views.views_all.RocnikView`
-	- ``cislo/<int:rocnik>.<str:cislo>/`` (seminar_cislo) :class:`~seminar.views.views_all.CisloView`
-	- ``problem/<int:pk>/`` (seminar_problem) :func:`~seminar.views.views_all.problemView`
-- Zadání
-	- ``aktualni/zadani/`` (seminar_aktualni_zadani) :func:`~seminar.views.views_all.AktualniZadaniView`
-	- ``aktualni/vysledkova-listina/`` (seminar_aktualni_vysledky) :func:`~seminar.views.views_all.ZadaniAktualniVysledkovkaView`
-	- ``aktualni/rocnik/`` (seminar_aktualni_rocnik) :class:`~seminar.views.views_all.AktualniRocnikRedirectView`
-- Články
-	- ``archiv/clanky/`` (clanky_resitel) :class:`~seminar.views.views_all.ClankyResitelView`
-- Orgovské stránky
-	- ``rocnik/<int:rocnik>/vysledkovka.tex`` (seminar_rocnik_vysledkovka) :class:`~seminar.views.views_all.RocnikVysledkovkaView`
-	- ``rocnik/<int:rocnik>/resitele.csv`` (seminar_rocnik_resitele_csv) :func:`~seminar.views.views_all.resiteleRocnikuCsvExportView`
-	- ``cislo/<int:rocnik>.<str:cislo>/vysledkovka.tex`` (seminar_cislo_vysledkovka) :class:`~seminar.views.views_all.CisloVysledkovkaView`
-	- ``cislo/<int:rocnik>.<str:cislo>/obalky.pdf`` (seminar_cislo_obalky) :func:`~seminar.views.views_all.cisloObalkyView`
-	- ``cislo/<int:rocnik>.<str:cislo>/tituly.tex`` (seminar_cislo_titul) :func:`~seminar.views.views_all.TitulyView`
-	- ``stav`` (stav_databaze) :func:`~seminar.views.views_all.StavDatabazeView`
-	- ``cislo/<int:trocnik>.<str:tcislo>/odmeny/<int:frocnik>.<str:fcislo>/`` (seminar_archiv_odmeny) :class:`~seminar.views.views_all.OdmenyView`
-- Další
-	- `` `` (titulni_strana) :class:`~seminar.views.views_all.TitulniStranaView`
-	- ``jak-resit/`` (jak_resit) :class:`~seminar.views.views_all.JakResitView`
-	- ``stare-novinky/`` (stare_novinky) :class:`~seminar.views.views_all.StareNovinkyView`
-"""
 from django.urls import path, include, re_path
 from . import views
 from .utils import org_required
diff --git a/soustredeni/apps.py b/soustredeni/apps.py
index a0a8dae5..5d282341 100644
--- a/soustredeni/apps.py
+++ b/soustredeni/apps.py
@@ -1,6 +1,3 @@
-"""
-Soubor sloužící k pojmenování a jiným nastavením djangovské aplikace.
-"""
 from django.apps import AppConfig
 
 
diff --git a/treenode/apps.py b/treenode/apps.py
index 8e7df6fc..95139dc6 100644
--- a/treenode/apps.py
+++ b/treenode/apps.py
@@ -1,6 +1,3 @@
-"""
-Soubor sloužící k pojmenování a jiným nastavením djangovské aplikace.
-"""
 from django.apps import AppConfig
 
 
diff --git a/treenode/urls.py b/treenode/urls.py
index 1b6444bb..60dc88ad 100644
--- a/treenode/urls.py
+++ b/treenode/urls.py
@@ -1,8 +1,3 @@
-"""
-Soubor sloužící jako „router“, tj. zde se definují url adresy a na co ukazují:
-
-- Zatím tu nic moc není…
-"""
 from django.urls import path, re_path
 from . import views
 
diff --git a/various/apps.py b/various/apps.py
index bf6023f0..c24a4428 100644
--- a/various/apps.py
+++ b/various/apps.py
@@ -1,6 +1,3 @@
-"""
-Soubor sloužící k pojmenování a jiným nastavením djangovské aplikace.
-"""
 from django.apps import AppConfig
 
 
diff --git a/various/autentizace/urls.py b/various/autentizace/urls.py
index a89ff89e..83c8e50e 100644
--- a/various/autentizace/urls.py
+++ b/various/autentizace/urls.py
@@ -1,16 +1,3 @@
-"""
-Soubor sloužící jako „router“, tj. zde se definují url adresy a na co ukazují:
-
-- ``prihlasit/`` (login) :class:`~various.autentizace.views.LoginView`
-- ``login/`` :class:`django.views.generic.base.RedirectView` předchozího
-- ``odhlasit/`` (logout) :class:`~various.autentizace.views.LogoutView`
-- ``logout/`` :class:`django.views.generic.base.RedirectView` předchozího
-- ``reset-hesla/`` (reset_password) :class:`~various.autentizace.views.PasswordResetView`
-- ``zmena-hesla/`` (change_password) :class:`~various.autentizace.views.PasswordChangeView`
-- ``zmena-hesla/2/`` (reset_password_done) :class:`~various.autentizace.views.PasswordResetDoneView`
-- ``reset-hesla/potvrzeni/<uidb64>/<token>/`` (reset_password_confirm) :class:`~various.autentizace.views.PasswordResetConfirmView`
-- ``reset-hesla/hotovo/`` (reset_password_complete) :class:`~various.autentizace.views.PasswordResetCompleteView`
-"""
 from django.urls import path
 from . import views
 from django.views.generic.base import RedirectView
diff --git a/vysledkovky/apps.py b/vysledkovky/apps.py
index de1c2bde..7221864c 100644
--- a/vysledkovky/apps.py
+++ b/vysledkovky/apps.py
@@ -1,6 +1,3 @@
-"""
-Soubor sloužící k pojmenování a jiným nastavením djangovské aplikace.
-"""
 from django.apps import AppConfig