Oprava varování při buildu dokumentace #154

Merged
zelvuska merged 6 commits from sphinx-manager-descriptor into develop 2026-11-07 17:15:15 +01:00
Owner

Build dokumentace měl 346 varování a nenaimportoval řadu modulů. Po tomto PR zbývá jen 5 varování toc.not_included.

Managery zděděných modelů

sphinxcontrib_django patchuje ManagerDescriptor.__get__ na return self.manager, což je u zděděných managerů manager rodiče. Tema.objects tak dotazoval Problem (order_by('rocnik') → FieldError) a TextNodeViewSet/CastNodeViewSet dostaly v routeru stejný basename polymorphicmodel. Kvůli tomu padaly importy tvorba.views, tvorba.urls, various.*, treenode.routers a mamweb.urls.

Oprava: v setup() v docs/conf.py (běží až po setupu rozšíření) patch přepíšeme verzí, která vrací manager dané třídy jako Django.

Staré vygenerované moduly

docs/modules je celé generované (a v .gitignore), ale sphinx-apidoc -f staré soubory nemaže. Zůstávaly tam moduly po seminar.*, treenode.models a migracích → chyby importu a stovky duplicit. make html teď modules nejdřív smaže.

Kolize labelů sekcí

autosectionlabel dělal z nadpisů globální labely, takže stejné nadpisy v různých souborech kolidovaly (manage.py, Make skripty, Dokumentace, Testy). Zapnuto autosectionlabel_prefix_document, existující :ref: odkazy převedeny na tvar dokument:Nadpis. Opakované „Názory“ v rámci jednoho zápisu jsou přejmenované na „Názory na …“.

Drobnosti

  • opravené docstringy v tvorba/utils.py, prednasky/models.py a galerie/__init__.py (reST formátování, neexistující role :py:module:)
  • příliš krátká podtržení nadpisů v index.rst, skripty.rst, vyvoj.rst a odrážka v css.rst

Lokální výpis varování

settings_local má disable_existing_loggers: True, takže každé django.setup() vypnulo loggery Sphinxu a lokální build nevypisoval varování ani průběh. conf.py teď nastaví LOGGING_CONFIG = None, takže Django při buildu dokumentace logging vůbec nekonfiguruje.

Zbývá

april.rst, css.rst, default_doc.rst, docker.rst a struktura.rst nejsou v žádném toctree – buď přidat do index.rst, nebo označit :orphan:.

🤖 Generated with Claude Code

https://claude.ai/code/session_01LX8JE3FxJfRKaAQN8kLQMT

Build dokumentace měl 346 varování a nenaimportoval řadu modulů. Po tomto PR zbývá jen 5 varování `toc.not_included`. ## Managery zděděných modelů `sphinxcontrib_django` patchuje `ManagerDescriptor.__get__` na `return self.manager`, což je u zděděných managerů manager rodiče. `Tema.objects` tak dotazoval `Problem` (`order_by('rocnik')` → `FieldError`) a `TextNodeViewSet`/`CastNodeViewSet` dostaly v routeru stejný basename `polymorphicmodel`. Kvůli tomu padaly importy `tvorba.views`, `tvorba.urls`, `various.*`, `treenode.routers` a `mamweb.urls`. Oprava: v `setup()` v `docs/conf.py` (běží až po setupu rozšíření) patch přepíšeme verzí, která vrací manager dané třídy jako Django. ## Staré vygenerované moduly `docs/modules` je celé generované (a v `.gitignore`), ale `sphinx-apidoc -f` staré soubory nemaže. Zůstávaly tam moduly po `seminar.*`, `treenode.models` a migracích → chyby importu a stovky duplicit. `make html` teď `modules` nejdřív smaže. ## Kolize labelů sekcí `autosectionlabel` dělal z nadpisů globální labely, takže stejné nadpisy v různých souborech kolidovaly (`manage.py`, `Make skripty`, `Dokumentace`, `Testy`). Zapnuto `autosectionlabel_prefix_document`, existující `:ref:` odkazy převedeny na tvar `dokument:Nadpis`. Opakované „Názory“ v rámci jednoho zápisu jsou přejmenované na „Názory na …“. ## Drobnosti - opravené docstringy v `tvorba/utils.py`, `prednasky/models.py` a `galerie/__init__.py` (reST formátování, neexistující role `:py:module:`) - příliš krátká podtržení nadpisů v `index.rst`, `skripty.rst`, `vyvoj.rst` a odrážka v `css.rst` ## Lokální výpis varování `settings_local` má `disable_existing_loggers: True`, takže každé `django.setup()` vypnulo loggery Sphinxu a lokální build nevypisoval varování ani průběh. `conf.py` teď nastaví `LOGGING_CONFIG = None`, takže Django při buildu dokumentace logging vůbec nekonfiguruje. ## Zbývá `april.rst`, `css.rst`, `default_doc.rst`, `docker.rst` a `struktura.rst` nejsou v žádném toctree – buď přidat do `index.rst`, nebo označit `:orphan:`. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01LX8JE3FxJfRKaAQN8kLQMT
sphinxcontrib_django patchuje ManagerDescriptor.__get__ tak, že vrací
manager rodiče, takže Tema.objects dotazoval Problem a polymorfní
viewsety dostaly stejný basename v routeru. Přepisujeme patch verzí,
která vrací manager dané třídy.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LX8JE3FxJfRKaAQN8kLQMT
docs/modules je celé generované sphinx-apidoc, ale -f staré soubory
nemaže, takže zůstávaly moduly po seminar.* a treenode.models.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LX8JE3FxJfRKaAQN8kLQMT
zelvuska changed title from Sphinx: správné managery zděděných modelů to Oprava varování při buildu dokumentace 2026-11-07 17:02:54 +01:00
Stejné nadpisy v různých souborech (manage.py, Make skripty, Dokumentace,
…) kolidovaly. Odkazy :ref: převedeny na tvar dokument:Nadpis. Navíc
opravena krátká podtržení nadpisů a odrážka v css.rst.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LX8JE3FxJfRKaAQN8kLQMT
settings_local má disable_existing_loggers: True, takže django.setup()
vypínalo loggery Sphinxu a lokálně se nevypisovala varování ani průběh.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LX8JE3FxJfRKaAQN8kLQMT
zelvuska merged commit 525494fd2f into develop 2026-11-07 17:15:15 +01:00
zelvuska deleted branch sphinx-manager-descriptor 2026-11-07 17:15:15 +01:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
mam/mamweb!154
No description provided.