Merge pull request #432 from pyvec/honzajavorek/gen

Change how files get generated, use local Twemoji

Author: honzajavorek

.github/workflows/check_links.yml

@@ -14,12 +14,12 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v6
       - name: Build documentation
-        run: uv run sphinx-build -nWaE docs build
+        run: uv run pyvec-docs build
       - name: Link Checker
         id: lychee
         uses: lycheeverse/lychee-action@v2
         with:
-          args: _build
+          args: build
           fail: false
       - name: Create Issue From File
         if: steps.lychee.outputs.exit_code != 0

.github/workflows/generate.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/test.yml

@@ -10,6 +10,6 @@ jobs:
     - name: Install uv
       uses: astral-sh/setup-uv@v6
     - name: Test
-      run: uv run pytest
+      run: uv run pyvec-docs test
     - name: Build documentation
-      run: uv run sphinx-build -nWaE docs build
+      run: uv run pyvec-docs build

.github/workflows/update_pages.yml

@@ -21,7 +21,7 @@ Když toho upravujete víc, nebo máte zálusk na nějaké složitější kejkle
 Běžná práce
 -----------
 
-#. Ve virtuálním prostředí spusťte projekt: ``uv run sphinx-autobuild docs build``
+#. Ve virtuálním prostředí spusťte projekt: ``uv run pyvec-docs build``
 #. 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`
@@ -90,28 +90,15 @@ Na repozitáři je zapojená `GitHub Action <https://github.com/lycheeverse/lych
 
 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_boards:
+.. _generate_files:
 
-Skript na generování historie výborů
-------------------------------------
+Generování stránek a souborů
+----------------------------
 
-V adresáři ``scripts`` je skript ``generate_boards.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/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``,
-* 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.
 
-Výsledná stránka je pouze informační, kanonickým zdrojem pravdy jsou v tomto případě státní registry.
-
-.. _generate_grants:
-
-Skript na generování zápisů hlasování o grantech
-------------------------------------------------
-
-V adresáři ``scripts`` je skript ``generate_grants.py``, který:
-
-* 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.
-
-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. Skript započítává pouze hlasy od členů výboru (podle `souboru boards.toml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/boards.toml>`_).
+Kód pro generování je v ``src/pyvec_docs/cli.py``. Skripty jde pouštět např. ``uv run pyvec-docs gen-boards``.

CONTRIBUTING.rst

@@ -142,6 +142,7 @@
 
 # Ensures consistent emoji style on all computers, operating systems, browsers
 sphinxemoji_style = "twemoji"
+sphinxemoji_source = "_static/twemoji.min.js"
 
 
 # -- Setting up extensions ---------------------------------------------------

docs/_static/twemoji.min.js

@@ -3,7 +3,7 @@ Výbory spolku
 
 Historie složení :term:`výboru <Výbor>`. Kanonickým zdrojem pravdy je `výpis na justice.cz <https://or.justice.cz/ias/ui/rejstrik-firma.vysledky?subjektId=760829&typ=UPLNY>`_. Historii výborů si pro vlastní potřeby zaznamenáváme do `souboru boards.toml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/boards.toml>`_ a z něj se generuje i tato stránka.
 
-Kdyby něco nesedělo, ověřte `historii zdrojáku této stránky <https://github.com/pyvec/docs.pyvec.org/commits/master/docs/operations/boards.rst>`_ a funkčnost :ref:`přepisů <generate_boards>`.
+Kdyby něco nesedělo, ověřte `historii zdrojáku této stránky <https://github.com/pyvec/docs.pyvec.org/commits/master/docs/operations/boards.rst>`_ a funkčnost :ref:`přepisů <generate_files>`.
 
 .. Soubor docs/operations/boards.rst je generován skriptem scripts/generate_boards.py ze šablony docs/operations/boards.rst.jinja. Neupravovat ručně!
 
@@ -14,35 +14,35 @@ Výbor od 9.4.2022
 .. csv-table::
    :header: "Jméno", "GitHub", "Funkce"
 
-   Barbora Drbohlavová, `@baradrb <https://github.com/baradrb>`_, |:crown:| 
-   Anežka Müller, `@anezkamll <https://github.com/anezkamll>`_, 
-   Jan Javorek, `@honzajavorek <https://github.com/honzajavorek>`_, 
-   Jakub Vysoký, `@kvbik <https://github.com/kvbik>`_, 
-   Jan Čermák, `@sairon <https://github.com/sairon>`_, |:moneybag:| 
+   Barbora Drbohlavová, `@baradrb <https://github.com/baradrb>`_, |:crown:|
+   Anežka Müller, `@anezkamll <https://github.com/anezkamll>`_,
+   Jan Javorek, `@honzajavorek <https://github.com/honzajavorek>`_,
+   Jakub Vysoký, `@kvbik <https://github.com/kvbik>`_,
+   Jan Čermák, `@sairon <https://github.com/sairon>`_, |:moneybag:|
 
 Výbor od 8.4.2019
 -------------------------------------------------
 
 .. csv-table::
    :header: "Jméno", "GitHub", "Funkce"
 
-   Martin Bílek, `@martinbilek <https://github.com/martinbilek>`_, |:crown:| |:moneybag:| 
-   Aleš Zoulek, `@aleszoulek <https://github.com/aleszoulek>`_, 
-   Jan Javorek, `@honzajavorek <https://github.com/honzajavorek>`_, 
-   Jakub Vysoký, `@kvbik <https://github.com/kvbik>`_, 
-   Jiří Bartoň, `@whiskybar <https://github.com/whiskybar>`_, 
+   Martin Bílek, `@martinbilek <https://github.com/martinbilek>`_, |:crown:| |:moneybag:|
+   Aleš Zoulek, `@aleszoulek <https://github.com/aleszoulek>`_,
+   Jan Javorek, `@honzajavorek <https://github.com/honzajavorek>`_,
+   Jakub Vysoký, `@kvbik <https://github.com/kvbik>`_,
+   Jiří Bartoň, `@whiskybar <https://github.com/whiskybar>`_,
 
 Výbor od 27.3.2012
 -------------------------------------------------
 
 .. csv-table::
    :header: "Jméno", "GitHub", "Funkce"
 
-   Martin Bílek, `@martinbilek <https://github.com/martinbilek>`_, |:crown:| |:moneybag:| 
-   Aleš Zoulek, `@aleszoulek <https://github.com/aleszoulek>`_, 
-   Robin Gottfried, `@czervenka <https://github.com/czervenka>`_, 
-   Jan Král, `@honzakral <https://github.com/honzakral>`_, 
-   Jakub Vysoký, `@kvbik <https://github.com/kvbik>`_, 
-   Jiří Bartoň, `@whiskybar <https://github.com/whiskybar>`_, 
-   Vítězslav Pliska, `@whit <https://github.com/whit>`_, 
+   Martin Bílek, `@martinbilek <https://github.com/martinbilek>`_, |:crown:| |:moneybag:|
+   Aleš Zoulek, `@aleszoulek <https://github.com/aleszoulek>`_,
+   Robin Gottfried, `@czervenka <https://github.com/czervenka>`_,
+   Jan Král, `@honzakral <https://github.com/honzakral>`_,
+   Jakub Vysoký, `@kvbik <https://github.com/kvbik>`_,
+   Jiří Bartoň, `@whiskybar <https://github.com/whiskybar>`_,
+   Vítězslav Pliska, `@whit <https://github.com/whit>`_,
 

docs/conf.py

@@ -1,11 +1,15 @@
 Výbory spolku
 =============
 
-Historie složení :term:`výboru <Výbor>`. Kanonickým zdrojem pravdy je `výpis na justice.cz <https://or.justice.cz/ias/ui/rejstrik-firma.vysledky?subjektId=760829&typ=UPLNY>`_. Historii výborů si pro vlastní potřeby zaznamenáváme do `souboru boards.toml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/boards.toml>`_ a z něj se generuje i tato stránka.
+Historii :term:`výborů <Výbor>` si pro vlastní potřeby zaznamenáváme do `souboru boards.toml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/boards.toml>`_ a z něj se generuje i tato stránka. Kdyby něco nesedělo, ověřte `historii zdrojáku této stránky <https://github.com/pyvec/docs.pyvec.org/commits/master/docs/operations/boards.rst>`_ a funkčnost :ref:`přepisů <generate_files>`.
+
+Kanonickým zdrojem pravdy je ale `výpis na justice.cz <https://or.justice.cz/ias/ui/rejstrik-firma.vysledky?subjektId=760829&typ=UPLNY>`_.
+
+
+
+.. Soubor docs/operations/boards.rst je generován, NEUPRAVOVAT RUČNĚ!
 
-Kdyby něco nesedělo, ověřte `historii zdrojáku této stránky <https://github.com/pyvec/docs.pyvec.org/commits/master/docs/operations/boards.rst>`_ a funkčnost :ref:`přepisů <generate_boards>`.
 
-.. Soubor docs/operations/boards.rst je generován skriptem scripts/generate_boards.py ze šablony docs/operations/boards.rst.jinja. Neupravovat ručně!
 
 {% for board in boards %}
 Výbor od {{ board.start_on.strftime("%-d.%-m.%Y") }}

docs/operations/boards.rst

@@ -1,7 +1,7 @@
 Elektronická hlasování o grantech
 =================================
 
-Od roku 2020 o grantech :term:`výbor <Výbor>` hlasuje prostřednictvím repozitáře `pyvec/money <https://github.com/pyvec/money>`_. Zde je strojový přepis proběhlých hlasování. Kanonickým zdrojem pravdy je hlasování přímo na GitHub Issues. Kdyby něco nesedělo, ověřte `historii zdrojáku této stránky <https://github.com/pyvec/docs.pyvec.org/commits/master/docs/operations/grants.rst>`_ a funkčnost :ref:`přepisů <generate_grants>`.
+Od roku 2020 o grantech :term:`výbor <Výbor>` hlasuje prostřednictvím repozitáře `pyvec/money <https://github.com/pyvec/money>`_. Zde je strojový přepis proběhlých hlasování. Kanonickým zdrojem pravdy je hlasování přímo na GitHub Issues. Kdyby něco nesedělo, ověřte `historii zdrojáku této stránky <https://github.com/pyvec/docs.pyvec.org/commits/master/docs/operations/grants.rst>`_ a funkčnost :ref:`přepisů <generate_files>`.
 
 .. Soubor docs/operations/grants.rst je generován skriptem scripts/generate_grants.py ze šablony docs/operations/grants.rst.jinja. Neupravovat ručně!
 
@@ -339,7 +339,7 @@ Dne 25. 7. 2023 požádal uživatel `@clytaemnestra <https://github.com/clytaemn
     2990
 
     **Na jakou věc to je?**
-    trička na EuroPython pro stankaře 
+    trička na EuroPython pro stankaře
 
     **Proč? (čemu prospějeme, proč je to dobrý nápad, jaký to bude mít dopad?)**
     promoce PyCon CZ a české komunity
@@ -366,7 +366,7 @@ Dne 13. 6. 2023 požádal uživatel `@befeleme <https://github.com/befeleme>`_ o
     Karolina Surma - PyLadies
 
     **Kolik potřebujete? (aspoň odhad nebo rozmezí)**
-    ~6800 Kč 
+    ~6800 Kč
 
     *detailně*
     hlavička: 6.24 Kč / ks = 2496 Kč
@@ -403,7 +403,7 @@ Dne 27. 2. 2023 požádal uživatel `@Zuzanita <https://github.com/Zuzanita>`_ o
 .. code-block:: text
 
     **Kdo jste?**
-    Organizátoři PyLadies - podává Zuzana Pokorná za všechny 
+    Organizátoři PyLadies - podává Zuzana Pokorná za všechny
 
     **Kolik potřebujete? (aspoň odhad nebo rozmezí)**
     25 000 Kč z toho bude část vrácena z příspěvků jednotlivců na trička
@@ -613,15 +613,15 @@ Dne 16. 12. 2020 požádal uživatel `@kvbik <https://github.com/kvbik>`_ o gran
 
     **Kdo jste?**
 
-    Jakub Vysoky, clen Pyvec, spolu organizator prazskeho Pyva 
+    Jakub Vysoky, clen Pyvec, spolu organizator prazskeho Pyva
 
     **Kolik potřebujete? (aspoň odhad nebo rozmezí)**
 
     Do 15tis Kc. (jidlo a piti na 3-4 dny pro 20-30 lidi)
 
     **Na jakou věc to je?**
 
-    Letni edice Python komunitniho Sprintu ve Msenych-laznich v srpen 2020. 
+    Letni edice Python komunitniho Sprintu ve Msenych-laznich v srpen 2020.
 
     **Proč? (čemu prospějeme, proč je to dobrý nápad, jaký to bude mít dopad?)**
 
@@ -651,13 +651,13 @@ Dne 26. 2. 2020 požádal uživatel `@radusaaa <https://github.com/radusaaa>`_ o
     PyLadies Praha
 
     **Kolik potřebujete? (aspoň odhad nebo rozmezí)**
-    500,- Kč za oba běhy 
+    500,- Kč za oba běhy
 
     **Na jakou věc to je?**
 
     - kancelářské potřeby
 
-    - drobné odměny do soutěží 
+    - drobné odměny do soutěží
 
     **Proč? (čemu prospějeme, proč je to dobrý nápad, jaký to bude mít dopad?)**
     Organizujeme dva běhy začátečnických kurzů viz https://pyladies.cz/praha/. Součástí kurzů jsou i dva sobotní celodenní pyworkingy a závěrečný hackathon.

docs/operations/boards.rst.jinja

@@ -1,9 +1,17 @@
 Elektronická hlasování o grantech
 =================================
 
-Od roku 2020 o grantech :term:`výbor <Výbor>` hlasuje prostřednictvím repozitáře `pyvec/money <https://github.com/pyvec/money>`_. Zde je strojový přepis proběhlých hlasování. Kanonickým zdrojem pravdy je hlasování přímo na GitHub Issues. Kdyby něco nesedělo, ověřte `historii zdrojáku této stránky <https://github.com/pyvec/docs.pyvec.org/commits/master/docs/operations/grants.rst>`_ a funkčnost :ref:`přepisů <generate_grants>`.
+Od roku 2020 o grantech :term:`výbor <Výbor>` hlasuje prostřednictvím repozitáře `pyvec/money <https://github.com/pyvec/money>`_.
+
+Hlasování o grantech probíhá :ref:`pomocí reakcí <jak-hlasovani>` na GitHub Issues. Hlasování se automaticky archivují 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 přepis. Skript započítává pouze hlasy od členů výboru (podle `souboru boards.toml <https://github.com/pyvec/docs.pyvec.org/blob/master/src/pyvec_docs/boards.toml>`_).
+
+Kdyby něco nesedělo, ověřte `historii zdrojáku této stránky <https://github.com/pyvec/docs.pyvec.org/commits/master/docs/operations/grants.rst>`_ a funkčnost :ref:`přepisů <generate_files>`.
+
+
+
+.. Soubor docs/operations/grants.rst je generován, NEUPRAVOVAT RUČNĚ!
+
 
-.. Soubor docs/operations/grants.rst je generován skriptem scripts/generate_grants.py ze šablony docs/operations/grants.rst.jinja. Neupravovat ručně!
 
 {% for grant in grants %}
 {{ grant.voted_at.day }}. {{ grant.voted_at.month }}. {{ grant.voted_at.year }} - elektronické hlasování výboru

docs/operations/grants.rst

@@ -3,6 +3,7 @@ name = "pyvec-docs"
 version = "0"
 requires-python = "==3.12.*"
 dependencies = [
+    "click==8.1.8",
     "jinja2==3.1.6",
     "myst-parser==4.0.1",
     "pydantic==2.11.4",
@@ -12,6 +13,9 @@ dependencies = [
     "sphinxemoji==0.3.1",
 ]
 
+[project.scripts]
+pyvec-docs = "pyvec_docs.cli:main"
+
 [dependency-groups]
 dev = [
     "pytest-ruff==0.4.1",