Skip to content

README: add command for sphinx-build #438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

README: add command for sphinx-build #438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26ba4de
README: add command for sphinx-build
encukou May 14, 2025
fd5d175
Update uv.lock to version 2
encukou May 14, 2025
e25bc5d
Add --locked to README command to avoid spurious diffs
encukou May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,14 @@ Jejich cílem je poskytnout materiály a *know-how* pro pořadatele a částečn
i účastníky (např. kouče) různých akcí, jako jsou srazy, workshopy, kurzy.

Dokumentace je tvořena jako `otevřená <https://cs.wikipedia.org/wiki/Otev%C5%99en%C3%BD_software>`__, do jejího zdrojového kódu a textů může kdokoliv navrhovat změny. Texty a obrázky těchto materiálů jsou uvolněny pod licencí `CC BY-SA 4.0 <https://creativecommons.org/licenses/by-sa/4.0/deed.cs>`__.


Lokální spuštění
----------------

Dokumentaci je možné editovat přes GitHub; pro každý *pull request* se
vygeneruje náhled.
Kdo chce pracovat na svém stroji, může dokumentaci sestavit do adresáře
``build`` pomocí tohoto příkazu::

uv run --locked python -m sphinx build docs build
Loading