Merge pull request #423 from pyvec/honzajavorek/structure

Change repo structure

Author: honzajavorek

.github/workflows/check_links.yml

@@ -14,7 +14,7 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v6
       - name: Build documentation
-        run: uv run sphinx-build -nWaE . _build
+        run: uv run sphinx-build -nWaE docs build
       - name: Link Checker
         id: lychee
         uses: lycheeverse/lychee-action@v2

.github/workflows/generate_grants.yml

@@ -13,14 +13,14 @@ jobs:
     - name: Install uv
       uses: astral-sh/setup-uv@v6
     - name: Generate the list of grants
-      run: uv run python _scripts/generate_grants.py > ./operations/grants.rst
+      run: uv run python scripts/generate_grants.py > ./docs/operations/grants.rst
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     - name: Create PR
       uses: peter-evans/create-pull-request@v7
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
-        add-paths: ./operations/grants.rst
+        add-paths: ./docs/operations/grants.rst
         commit-message: "update the list of grants (generated)"
         branch: automation/grants
         title: "Automated update of the list of grants"

.github/workflows/test.yml

@@ -12,4 +12,4 @@ jobs:
     - name: Test
       run: uv run pytest
     - name: Build documentation
-      run: uv run sphinx-build -nWaE . _build
+      run: uv run sphinx-build -nWaE docs build

.readthedocs.yml

@@ -8,5 +8,5 @@ python:
     - method: pip
       path: .
 sphinx:
-  configuration: conf.py
+  configuration: docs/conf.py
   fail_on_warning: true

CONTRIBUTING.rst

@@ -1,4 +1,4 @@
-Copyright (c) 2024 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

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Pyvec, z.s. <[email protected]>
+Copyright (c) 2025 Pyvec, z.s. <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

LICENSE.MIT

@@ -1,6 +1,15 @@
 # Configuration file for the Sphinx documentation builder
 
 import os
+import tomllib
+
+
+# -- Metadata reading --------------------------------------------------------
+
+with open("../pyproject.toml", "rb") as f:
+    pyproject = tomllib.load(f)
+pyproject_version = pyproject["project"]["version"]
+pyproject_name = pyproject["project"]["name"]
 
 
 # -- Project information -----------------------------------------------------
@@ -10,7 +19,7 @@
 author = "Pyvec, z.s."
 
 # The short X.Y version
-version = ""
+version = pyproject_version
 # The full version, including alpha/beta/rc tags
 release = ""
 
@@ -53,18 +62,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .
-exclude_patterns = [
-    "_build",
-    "Thumbs.db",
-    ".DS_Store",
-    "venv",
-    ".venv",
-    ".github",
-    ".pytest_cache",
-    ".ruff_cache",
-    "src",
-    "tests",
-]
+exclude_patterns = ["Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "monokai"
@@ -89,7 +87,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "pyvec-doc"
+htmlhelp_basename = pyproject_name
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -100,15 +98,15 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, "pyvec.tex", project, author, "manual"),
+    (master_doc, pyproject_name + ".tex", project, author, "manual"),
 ]
 
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "pyvec", project, [author], 1)]
+man_pages = [(master_doc, pyproject_name, project, [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -117,7 +115,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, "pyvec", project, author, "pyvec", project, "Miscellaneous"),
+    (master_doc, pyproject_name, project, author, pyproject_name, project, "Miscellaneous"),
 ]
 
 

_static/custom.css renamed to docs/_static/custom.css

@@ -3,7 +3,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 tohoto souboru <https://github.com/pyvec/docs.pyvec.org/commits/master/operations/grants.rst>`_ a funkčnost :ref:`přepisů <generate_grants>`.
 
-.. Soubor operations/grants.rst je generován skriptem _scripts/generate_grants.py ze šablony operations/grants.rst.jinja. Neupravovat ručně!
+.. Soubor operations/grants.rst je generován skriptem scripts/generate_grants.py ze šablony 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