Compare commits

...

10 Commits

8 changed files with 58 additions and 11 deletions

View File

@@ -13,9 +13,14 @@ jobs:
environment: release environment: release
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: Install uv - name: Set up uv
run: pip install uv uses: astral-sh/setup-uv@v6
with:
python-version: "${{ matrix.python-version }}"
enable-cache: true
cache-dependency-glob: |
pyproject.toml
- name: Build package - name: Build package
run: uv build run: uv build
- name: Publish to PyPI - name: Publish to PyPI
run: uv publish run: uv publish --token ${{ secrets.PYPI_API_TOKEN }}

View File

@@ -82,5 +82,13 @@ jobs:
uv sync --group tests uv sync --group tests
- name: Run tests - name: Run tests
env:
PYTEST_ADDOPTS: "--cov-report=lcov"
run: | run: |
uv run test uv run test
- name: Upload coverage to Coveralls
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
file: coverage.lcov

20
.readthedocs.yaml Normal file
View File

@@ -0,0 +1,20 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the OS, Python version, and other tools you might need
build:
os: ubuntu-24.04
tools:
python: "3.13"
jobs:
pre_create_environment:
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
create_environment:
- uv sync --group docs
install:
- uv run python -m sphinx -T -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html

View File

@@ -47,8 +47,8 @@ master_doc = "index"
# General information about the project. # General information about the project.
project = "invenio-config-iform" project = "invenio-config-iform"
copyright = "2022, TU Graz" copyright = "2025, I-Form"
author = "TU Graz" author = "I-Form"
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
@@ -109,10 +109,10 @@ html_theme = "alabaster"
html_theme_options = { html_theme_options = {
"description": "invenio module that adds iform configs.", "description": "invenio module that adds iform configs.",
"github_user": "TU Graz", "github_user": "Cian-H",
"github_repo": "invenio-config-iform", "github_repo": "invenio-config-iform",
"github_button": False, "github_button": True,
"github_banner": True, "github_banner": False,
"show_powered_by": False, "show_powered_by": False,
"extra_nav_links": { "extra_nav_links": {
"invenio-config-iform@Github": "https://github.com/Cian-H/invenio-config-iform", "invenio-config-iform@Github": "https://github.com/Cian-H/invenio-config-iform",
@@ -244,7 +244,7 @@ latex_documents = [
master_doc, master_doc,
"invenio-config-iform.tex", "invenio-config-iform.tex",
"invenio-config-iform Documentation", "invenio-config-iform Documentation",
"Mojib Wali", "I-Form",
"manual", "manual",
), ),
] ]

View File

@@ -1 +0,0 @@
-e .[docs,tests]

View File

@@ -8,4 +8,4 @@
"""Metadata for this python module.""" """Metadata for this python module."""
__version__ = "2025.5.20.4" __version__ = "2025.5.20.13"

View File

@@ -67,6 +67,11 @@ tests = [
"ruff>=0.5.3", "ruff>=0.5.3",
"Sphinx>=4.5.0", "Sphinx>=4.5.0",
] ]
docs = [
"invenio-app>=1.5.0",
"invenio-search[opensearch2]>=2.1.0",
"Sphinx>=4.5.0",
]
[build-system] [build-system]
requires = ["hatchling", "hatch-calver"] requires = ["hatchling", "hatch-calver"]

10
uv.lock generated
View File

@@ -1722,6 +1722,11 @@ dev = [
{ name = "pydocstyle" }, { name = "pydocstyle" },
{ name = "ruff" }, { name = "ruff" },
] ]
docs = [
{ name = "invenio-app" },
{ name = "invenio-search", extra = ["opensearch2"] },
{ name = "sphinx" },
]
tests = [ tests = [
{ name = "invenio-app" }, { name = "invenio-app" },
{ name = "invenio-search", extra = ["opensearch2"] }, { name = "invenio-search", extra = ["opensearch2"] },
@@ -1745,6 +1750,11 @@ dev = [
{ name = "pydocstyle", specifier = ">=6.3.0" }, { name = "pydocstyle", specifier = ">=6.3.0" },
{ name = "ruff", specifier = ">=0.11.7" }, { name = "ruff", specifier = ">=0.11.7" },
] ]
docs = [
{ name = "invenio-app", specifier = ">=1.5.0" },
{ name = "invenio-search", extras = ["opensearch2"], specifier = ">=2.1.0" },
{ name = "sphinx", specifier = ">=4.5.0" },
]
tests = [ tests = [
{ name = "invenio-app", specifier = ">=1.5.0" }, { name = "invenio-app", specifier = ">=1.5.0" },
{ name = "invenio-search", extras = ["opensearch2"], specifier = ">=2.1.0" }, { name = "invenio-search", extras = ["opensearch2"], specifier = ">=2.1.0" },