From ee577583d8e97bb01505c2dd5b4e0202649651b5 Mon Sep 17 00:00:00 2001 From: Ayan Sinha Mahapatra Date: Tue, 26 Aug 2025 20:36:58 +0530 Subject: [PATCH] Update RTD docs builds Signed-off-by: Ayan Sinha Mahapatra --- .github/workflows/docs-ci.yml | 13 +++---------- .readthedocs.yml | 4 ++-- Makefile | 5 ++++- setup.cfg | 3 ++- 4 files changed, 11 insertions(+), 14 deletions(-) diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml index 0c06ac6..3a12f80 100644 --- a/.github/workflows/docs-ci.yml +++ b/.github/workflows/docs-ci.yml @@ -9,7 +9,7 @@ jobs: strategy: max-parallel: 4 matrix: - python-version: [3.9] + python-version: [3.13] steps: - name: Checkout code @@ -20,15 +20,8 @@ jobs: with: python-version: ${{ matrix.python-version }} - - name: Install Dependencies - run: pip install -e .[docs] - - name: Check Sphinx Documentation build minimally - working-directory: ./docs - run: sphinx-build -E -W source build + run: make docs - name: Check for documentation style errors - working-directory: ./docs - run: ./scripts/doc8_style_check.sh - - + run: make check diff --git a/.readthedocs.yml b/.readthedocs.yml index 8ab2368..3028be4 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -7,9 +7,9 @@ version: 2 # Build in latest ubuntu/python build: - os: ubuntu-22.04 + os: ubuntu-24.04 tools: - python: "3.11" + python: "3.13" # Build PDF & ePub formats: diff --git a/Makefile b/Makefile index 6970889..23d40bf 100644 --- a/Makefile +++ b/Makefile @@ -9,7 +9,10 @@ conf: docs: conf rm -rf docs/build/ - @${ACTIVATE} sphinx-build docs/source docs/build/ + @${ACTIVATE} sphinx-build -E -W docs/source docs/build/ + +check: + @${ACTIVATE} doc8 --max-line-length 100 docs/source/ --ignore D000 --quiet clean: @echo "-> Clean the Python env" diff --git a/setup.cfg b/setup.cfg index 5623cf4..42ff897 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,6 @@ [metadata] name = aboutcode +version = 0.0.1 license = Apache-2.0 # description must be on ONE line https://github.com/pypa/setuptools/issues/1390 @@ -29,7 +30,7 @@ license_files = [options] zip_safe = false setup_requires = setuptools_scm[toml] >= 4 -python_requires = >=3.7 +python_requires = >=3.10 install_requires =