Compare commits

..

4 Commits

Author SHA1 Message Date
626eeafe25 Patch: documentation autobuild 2025-05-23 15:22:11 +01:00
62f4b88759 Updated shpinx config 2025-05-23 15:21:53 +01:00
d2ab271883 Added dependency group "docs" 2025-05-23 15:16:47 +01:00
725c4197b9 Fixed .readthedocs.yaml 2025-05-23 15:15:14 +01:00
5 changed files with 36 additions and 17 deletions

View File

@@ -9,14 +9,12 @@ build:
os: ubuntu-24.04
tools:
python: "3.13"
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
# declare the Python requirements required to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: docs/requirements.txt
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

@@ -45,8 +45,8 @@ master_doc = "index"
# General information about the project.
project = "invenio-theme-iform"
copyright = "2020, Graz University of Technology"
author = "Graz University of Technology"
copyright = "2025, I-Form"
author = "I-Form"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -109,8 +109,8 @@ html_theme_options = {
"description": "invenio module for I-Form theme.",
"github_user": "Cian-H",
"github_repo": "invenio-theme-iform",
"github_button": False,
"github_banner": True,
"github_button": True,
"github_banner": False,
"show_powered_by": False,
"extra_nav_links": {
"invenio-theme-iform@GitHub": "https://github.com/Cian-H/invenio-theme-iform",
@@ -242,7 +242,7 @@ latex_documents = [
master_doc,
"invenio-theme-iform.tex",
"invenio-theme-iform Documentation",
"Graz University of Technology",
"I-Form",
"manual",
),
]

View File

@@ -8,4 +8,4 @@
"""Metadata for this python module."""
__version__ = "2025.5.20.2"
__version__ = "2025.5.20.3"

View File

@@ -73,6 +73,13 @@ tests = [
"pytest-ruff>=0.4.1",
"Sphinx>=4.5.0",
]
docs = [
"invenio-app>=1.3.4",
"invenio-previewer>=3.0.0",
"invenio-rdm-records>=18.0.0",
"invenio-search[opensearch2]>=2.1.0",
"Sphinx>=4.5.0",
]
[build-system]
requires = ["hatchling", "hatch-calver"]

14
uv.lock generated
View File

@@ -2367,6 +2367,13 @@ dev = [
{ name = "pydocstyle" },
{ name = "ruff" },
]
docs = [
{ name = "invenio-app" },
{ name = "invenio-previewer" },
{ name = "invenio-rdm-records" },
{ name = "invenio-search", extra = ["opensearch2"] },
{ name = "sphinx" },
]
tests = [
{ name = "invenio-app" },
{ name = "invenio-previewer" },
@@ -2393,6 +2400,13 @@ dev = [
{ name = "pydocstyle", specifier = ">=6.3.0" },
{ name = "ruff", specifier = ">=0.11.7" },
]
docs = [
{ name = "invenio-app", specifier = ">=1.3.4" },
{ name = "invenio-previewer", specifier = ">=3.0.0" },
{ name = "invenio-rdm-records", specifier = ">=18.0.0" },
{ name = "invenio-search", extras = ["opensearch2"], specifier = ">=2.1.0" },
{ name = "sphinx", specifier = ">=4.5.0" },
]
tests = [
{ name = "invenio-app", specifier = ">=1.3.4" },
{ name = "invenio-previewer", specifier = ">=3.0.0" },