From c40769f9d754511e092ffe7ea2692b56b5afa3d4 Mon Sep 17 00:00:00 2001
From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>
Date: Sat, 1 Mar 2025 12:14:11 +0100
Subject: [PATCH 1/2] Update ReadTheDocs Configuration
---
.readthedocs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.readthedocs.yml b/.readthedocs.yml
index a23c582637d..11075b0fe2b 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -18,7 +18,7 @@ python:
install:
- method: pip
path: .
- - requirements: docs/requirements-docs.txt
+ - requirements: requirements-dev-all.txt
build:
os: ubuntu-22.04
From 210da89931c8ccec86eb4f667dab290cdcd28299 Mon Sep 17 00:00:00 2001
From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>
Date: Sat, 1 Mar 2025 12:20:26 +0100
Subject: [PATCH 2/2] Don't Run Doc Build in GH Actions
---
.../{docs.yml => docs-admonitions.yml} | 22 +++++--------------
1 file changed, 5 insertions(+), 17 deletions(-)
rename .github/workflows/{docs.yml => docs-admonitions.yml} (62%)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs-admonitions.yml
similarity index 62%
rename from .github/workflows/docs.yml
rename to .github/workflows/docs-admonitions.yml
index 9a54e51ce22..90ab6f8e97c 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs-admonitions.yml
@@ -1,9 +1,10 @@
-name: Test Documentation Build
+name: Test Admonitions Generation
on:
pull_request:
paths:
- telegram/**
- docs/**
+ - .github/workflows/docs-admonitions.yml
push:
branches:
- master
@@ -11,8 +12,8 @@ on:
permissions: {}
jobs:
- test-sphinx-build:
- name: test-sphinx-build
+ test-admonitions:
+ name: Test Admonitions Generation
runs-on: ${{matrix.os}}
permissions:
# for uploading artifacts
@@ -37,17 +38,4 @@ jobs:
python -W ignore -m pip install --upgrade pip
python -W ignore -m pip install -r requirements-dev-all.txt
- name: Test autogeneration of admonitions
- run: pytest -v --tb=short tests/docs/admonition_inserter.py
- - name: Build docs
- run: sphinx-build docs/source docs/build/html -W --keep-going -j auto
- - name: Upload docs
- uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
- with:
- name: HTML Docs
- retention-days: 7
- path: |
- # Exclude the .doctrees folder and .buildinfo file from the artifact
- # since they are not needed and add to the size
- docs/build/html/*
- !docs/build/html/.doctrees
- !docs/build/html/.buildinfo
+ run: pytest -v --tb=short tests/docs/admonition_inserter.py
\ No newline at end of file
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy