Merge in the main branch

Author: encukou

.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 1
+  groups:
+    python:
+      patterns: ["*"]
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 1

.github/workflows/build.yml

@@ -0,0 +1,30 @@
+name: Check Links
+on:
+  repository_dispatch:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 5 * * 2"
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write  # required for peter-evans/create-issue-from-file
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Build documentation
+        run: uv run pyvec-docs build
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@v2
+        with:
+          args: build
+          fail: false
+      - name: Create Issue From File
+        if: steps.lychee.outputs.exit_code != 0
+        uses: peter-evans/create-issue-from-file@v5
+        with:
+          title: Link Checker Report
+          content-filepath: ./lychee/out.md
+          labels: broken links

.github/workflows/check_links.yml

@@ -0,0 +1,31 @@
+name: Generate
+on:
+  push:
+    branches:
+      - master
+  schedule:
+    - cron: "0 4 * * *"
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+    - name: Generate grants
+      run: uv run pyvec-docs gen-grants
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Generate boards
+      run: uv run pyvec-docs gen-boards
+    - name: Generate Twemoji
+      run: uv run pyvec-docs gen-twemoji
+    - name: Create PR
+      uses: peter-evans/create-pull-request@v7
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        add-paths: docs
+        commit-message: "update generated files"
+        branch: automation/generate
+        title: "Automated update of generated pages and other files"
+        body: "For details, see [the docs](https://docs.pyvec.org/contributing.html#generovani-stranek-a-souboru) :book:"

.github/workflows/generate.yml

@@ -0,0 +1,15 @@
+name: Test
+on:
+  push:
+  pull_request:
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+    - name: Test
+      run: uv run pyvec-docs test
+    - name: Build documentation
+      run: uv run pyvec-docs build

.github/workflows/generate_grants.yml

@@ -103,5 +103,11 @@ venv.bak/
 # mypy
 .mypy_cache/
 
+# ruff
+.ruff_cache/
+
 # scripts/lint_requirements.sh
 *-requirements.txt
+
+# Lychee
+.lycheecache

.github/workflows/test.yml

@@ -1,11 +1,12 @@
 version: 2
 build:
-  image: latest
+  os: ubuntu-lts-latest
+  tools:
+    python: "3.12"
 python:
-  version: 3.7
   install:
-      - requirements: requirements.txt
+    - method: pip
+      path: .
 sphinx:
-  builder: html
-  configuration: conf.py
+  configuration: docs/conf.py
   fail_on_warning: true

.gitignore

@@ -13,29 +13,49 @@ Abyste něco změnili v textech, nemusíte nic instalovat. Obsah lze upravovat o
 Instalace
 ---------
 
-Když toho upravujete víc, nebo máte zálusk na nějaké složitější kejkle, je lepší mít materiály nainstalované na svém počítači. Projekt vyžaduje Python 3.7.
+Když toho upravujete víc, nebo máte zálusk na nějaké složitější kejkle, je lepší mít materiály nainstalované na svém počítači. Bude k tomu potřeba `uv <https://docs.astral.sh/uv/>`_:
 
 #. Stáhněte projekt: ``git clone https://github.com/pyvec/docs.pyvec.org.git``
-#. Vytvořte si a aktivujte virtuální prostředí
-#. Nainstalujte do prostředí závislosti: ``python -m pip install -r requirements.txt``
+#. Přejděte do něj: ``cd docs.pyvec.org``
+
+.. note::
+
+    O instalaci, včetně správy virtuálního prostředí, se postará
+    ``uv`` automaticky při prvním spuštění.
 
 Běžná práce
 -----------
 
-#. Ve virtuálním prostředí spusťte projekt: ``python -m sphinx-autobuild . _build``
+#. Spusťte projekt: ``uv run pyvec-docs watch``
 #. Otevřete si v prohlížeči `<http://127.0.0.1:8000>`_
 #. V editoru upravujete texty a v prohlížeči si kontrolujete výsledek
 #. Projekt zastavíte v terminálu pomocí :kbd:`Ctrl+C`
 
+Další užitečné nástroje, např. na jednorázové sestavení nebo na
+:ref:`generování stránek <generate_files>`,
+najdete spuštěním ``pyvec-docs`` bez podpříkazu: ``uv run pyvec-docs``
+
+
+Markdown
+^^^^^^^^
+
+Původně byla dokumentace psaná v reStructuredText. Nyní ale podporuje i Markdown. Asi zatím nebudeme přepisovat původní stránky, ale pokud chce někdo napsat něco nového, a vyhovoval by mu spíš Markdown, nechť klidně použije Markdown.
+
+Kdyby s tím byl nějaký problém, tady je `návod na kombo Sphinx + MyST <https://docs.readthedocs.io/en/stable/guides/migrate-rest-myst.html>`__.
+
 Emoji
 ^^^^^
 
-Při psaní můžete používat Emoji jako třeba |:cz:| nebo |:snake:|, ale nepište je přímo pomocí Unicode, ale za pomocí značek jako ``|:cz:|`` nebo ``|:snake:|``. Unicode znaky by se zobrazovaly na každém operačním systému jinak, ale tyto značky budou díky rozšíření `emojicodes <https://github.com/sphinx-contrib/emojicodes>`__ přeloženy na obrázky a ty se zobrazí vždy všem stejně. Mrkněte na `seznam podporovaných Emoji <https://sphinxemojicodes.readthedocs.io/>`__. Obrázky jsou z `Twemoji <https://twemoji.twitter.com/>`_.
+Při psaní můžete používat Emoji jako třeba |:cz:| nebo |:snake:|, ale nepište je přímo pomocí Unicode, ale za pomocí značek jako ``|:cz:|`` nebo ``|:snake:|``. Unicode znaky by se zobrazovaly na každém operačním systému jinak, ale tyto značky budou díky rozšíření `emojicodes <https://github.com/sphinx-contrib/emojicodes>`__ přeloženy na obrázky a ty se zobrazí vždy všem stejně. Mrkněte na `seznam podporovaných Emoji <https://sphinxemojicodes.readthedocs.io/>`__. Obrázky jsou z `Twemoji <https://github.com/twitter/twemoji>`_.
 
 Slack
 ^^^^^
 
-Při psaní lze psát ``:slack:`#pyladies``` nebo i jenom ``:slack:`pyladies```, což vytvoří odkaz na kanál :slack:`#pyladies` na Pyvec Slacku. Funguje to díky vlastnímu rozšíření Sphinxu, které lze najít v souboru ``_extensions/slack.py``.
+Při psaní lze psát ``:slack:`#pyladies`` nebo i jenom ``:slack:`pyladies``, což vytvoří odkaz na kanál :slack:`#pyladies` na Pyvec Slacku. Funguje to díky vlastnímu rozšíření Sphinxu, které lze najít v souboru ``_extensions/slack.py``.
+
+Všechny odkazy na kanál ``:slack:`#pyvec-board``, ať už je to ``:slack:`#pyvec-board`` nebo ``:slack:`#pyvec-board-2019-2021`` jsou automaticky předělány na odkaz na aktuální tajný kanál výboru. K určení správných roků se využívá `soubor boards.toml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/boards.toml>`_.
+
+.. _docs-pyvec-rtd:
 
 ReadTheDocs
 -----------
@@ -56,28 +76,39 @@ Tento projekt se původně jmenoval ``pyvec-guide`` a proto se tak jmenuje i pro
 Verze Pythonu
 -------------
 
-Nejnovější verze Pythonu, jakou ReadTheDocs podporují, je 3.7. Z toho důvodu ji vyžaduje i tento projekt. Nastavení je v souboru ``.readthedocs.yml`` (`dokumentace <https://docs.readthedocs.io/en/latest/config-file/v2.html>`_).
+Nejnovější verze Pythonu, jakou ReadTheDocs podporují, je 3.12. Z toho důvodu ji vyžaduje i tento projekt. Nastavení je v souboru ``.readthedocs.yml`` (`dokumentace <https://docs.readthedocs.io/en/latest/config-file/v2.html>`_).
 
 Continuous Integration
 ----------------------
 
 Na repozitáři jsou zapojeny `GitHub Actions <https://github.com/pyvec/docs.pyvec.org/actions>`_. Kontrolka:
 
-.. image:: https://github.com/pyvec/docs.pyvec.org/workflows/Main/badge.svg
+.. image:: https://github.com/pyvec/docs.pyvec.org/actions/workflows/test.yml/badge.svg
     :target: https://github.com/pyvec/docs.pyvec.org/actions
-    :alt: Continuous Integration Status
+    :alt: Continuous Integration Status (test)
 
 CI je pouze informativní a nezabrání tomu, aby se hlavní větev dostala do ReadTheDocs.
 
-.. _generate_grants:
+Kontrola rozbitých odkazů
+-------------------------
+
+Na repozitáři je zapojená `GitHub Action <https://github.com/lycheeverse/lychee-action>`_, která jednou denně kontroluje, zda všechny odkazy fungují. Kontrolka:
+
+.. image:: https://github.com/pyvec/docs.pyvec.org/actions/workflows/check_links.yml/badge.svg
+    :target: https://github.com/pyvec/docs.pyvec.org/actions
+    :alt: Continuous Integration Status (check links)
+
+Dokonce by to mělo automaticky zakládat i issue, pokud to najde nějaký problém. V případě, že je potřeba ignorovat nějakou doménu nebo konkrétní odkaz, je možné to udělat v souboru ``lychee.toml``.
+
+.. _generate_files:
 
-Skript na generování zápisů hlasování o grantech
-------------------------------------------------
+Generování stránek a souborů
+----------------------------
 
-V adresáři ``_scripts`` je skript ``generate_grants.py``, který:
+Některé stránky a soubory se generují automaticky pomocí skriptů. Tyto skripty se spouští pomocí `GitHub Actions <https://github.com/pyvec/docs.pyvec.org/actions>`_, konkrétně workflow ``generate.yml``. Tyto skripty se spouští jednou denně a generují soubory, které se pak posílají jako pull requesty do repozitáře, pokud vytvoří nějaké změny.
 
-* se pomocí `GitHub Actions <https://github.com/pyvec/docs.pyvec.org/actions>`_ jednou denně spustí
-* vygeneruje soubor ``operations/grants.rst`` z dat na `pyvec/money <https://github.com/pyvec/money>`_ a ze šablony ``operations/grants.rst``
-* commitne a pushne jej přes Git do repozitáře.
+- Generuje se ``docs/operations/boards.rst`` ze `souboru boards.toml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/boards.toml>`_ a ze šablony ``operations/boards.rst``.
+- Generuje se ``docs/operations/grants.rst`` z dat na `pyvec/money <https://github.com/pyvec/money>`_ a ze šablony ``operations/grants.rst``.
+- Generuje se ``docs/_static/twemoji.min.js``, abychom Twemoji měli lokálně a nemuseli se spoléhat na CDN.
 
-Hlasování o grantech probíhá :ref:`pomocí reakcí <jak-hlasovani>` na GitHub Issues a tento skript hlasování archivuje sem do dokumentace pro účely jednoduššího vyhledávání, zálohy, kdyby se s `pyvec/money <https://github.com/pyvec/money>`_ něco stalo, a pro nějakou historickou evidenci. Kanonickým zdrojem pravdy ale zůstává hlasování přímo na GitHub Issues, toto je jen automatizovaný přepis.
+Kód pro generování je v ``src/pyvec_docs/cli.py``. Skripty jde pouštět např. ``uv run pyvec-docs gen-boards``.

.readthedocs.yml

@@ -1,4 +1,4 @@
-Copyright (c) 2019 Pyvec, z.s. <[email protected]>
+Copyright (c) 2025 Pyvec, z.s. <[email protected]>
 
 Texty a obrázky materiálů jsou uvolněny pod licencí CC BY-SA 4.0
 https://creativecommons.org/licenses/by-sa/4.0