Compare commits

...

3 Commits

Author SHA1 Message Date
Cian-H 4fad1ced08 Updated sphinx documentation config 2025-05-23 15:20:26 +01:00
Cian-H 3bb38a95eb Removed default sphinx build pipeline 2025-05-23 14:57:39 +01:00
Cian-H 36f9b91cc1 Another attempt to fix readthedocs 2025-05-23 14:55:44 +01:00
5 changed files with 24 additions and 20 deletions
+2 -13
View File
@@ -15,17 +15,6 @@ build:
- asdf install uv latest
- asdf global uv latest
create_environment:
- uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
- uv sync --group docs
install:
- VIRTUAL_ENV="${READTHEDOCS_VIRTUALENV_PATH}" uv pip install -r docs/requirements.txt
# 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
- uv run python -m sphinx -T -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html
+6 -6
View File
@@ -47,8 +47,8 @@ master_doc = "index"
# General information about the project.
project = "invenio-config-iform"
copyright = "2022, TU Graz"
author = "TU Graz"
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,10 +109,10 @@ html_theme = "alabaster"
html_theme_options = {
"description": "invenio module that adds iform configs.",
"github_user": "TU Graz",
"github_user": "Cian-H",
"github_repo": "invenio-config-iform",
"github_button": False,
"github_banner": True,
"github_button": True,
"github_banner": False,
"show_powered_by": False,
"extra_nav_links": {
"invenio-config-iform@Github": "https://github.com/Cian-H/invenio-config-iform",
@@ -244,7 +244,7 @@ latex_documents = [
master_doc,
"invenio-config-iform.tex",
"invenio-config-iform Documentation",
"Mojib Wali",
"I-Form",
"manual",
),
]
+1 -1
View File
@@ -8,4 +8,4 @@
"""Metadata for this python module."""
__version__ = "2025.5.20.8"
__version__ = "2025.5.20.11"
+5
View File
@@ -67,6 +67,11 @@ tests = [
"ruff>=0.5.3",
"Sphinx>=4.5.0",
]
docs = [
"invenio-app>=1.5.0",
"invenio-search[opensearch2]>=2.1.0",
"Sphinx>=4.5.0",
]
[build-system]
requires = ["hatchling", "hatch-calver"]
Generated
+10
View File
@@ -1722,6 +1722,11 @@ dev = [
{ name = "pydocstyle" },
{ name = "ruff" },
]
docs = [
{ name = "invenio-app" },
{ name = "invenio-search", extra = ["opensearch2"] },
{ name = "sphinx" },
]
tests = [
{ name = "invenio-app" },
{ name = "invenio-search", extra = ["opensearch2"] },
@@ -1745,6 +1750,11 @@ dev = [
{ name = "pydocstyle", specifier = ">=6.3.0" },
{ 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 = [
{ name = "invenio-app", specifier = ">=1.5.0" },
{ name = "invenio-search", extras = ["opensearch2"], specifier = ">=2.1.0" },