Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a link checker step in the doctests jobs using both Lychee and … #4686

Open
wants to merge 15 commits into
base: develop
Choose a base branch
from
+49 −43
Open

Added a link checker step in the doctests jobs using both Lychee and … #4686

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
ff8f148
Added a link checker step in the doctests jobs using both Lychee and …
RohitP2005 Dec 17, 2024
e126bf5
Update .github/workflows/links.yml
RohitP2005 Dec 17, 2024
d6b7b20
Merge branch 'develop' into issue#3387
kratman Dec 17, 2024
38d3e96
Changes in kinks.yml[Build Pybam]
RohitP2005 Dec 18, 2024
404b928
feat: add docs.yml workflow to handle all CI tasks related to documen…
RohitP2005 Dec 18, 2024
8f5b5d4
Merge branch 'develop' into issue#3387
RohitP2005 Dec 18, 2024
3b642d7
Rearranging of functionalities and corrections were made
RohitP2005 Dec 18, 2024
63cc8f7
Update test_docs_build.yml
RohitP2005 Dec 18, 2024
034c389
performed pre-commit
RohitP2005 Dec 18, 2024
299697e
removed push and schedule from test_docs_buil.yml
RohitP2005 Dec 18, 2024
833358b
Modified build docs html in test_docs_build.yml
RohitP2005 Dec 18, 2024
ee5dc5c
added flags to ignore warning
RohitP2005 Dec 19, 2024
981a833
Modified the doctest command
RohitP2005 Dec 19, 2024
efbf6d6
Removed a comment from test_on_push.yml
RohitP2005 Dec 19, 2024
f955f5d
Merge branch 'pybamm-team:develop' into issue#3387
RohitP2005 Dec 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions .github/workflows/lychee_url_checker.yml → .github/workflows/links.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Check URLs with Lychee
name: Check URLs with Lychee and Sphinx

on:
push:
Expand All @@ -11,7 +11,7 @@ on:
- cron: "0 3 * * *"

jobs:
linkChecker:
linkCheckerLychee:
runs-on: ubuntu-latest
steps:

Expand Down Expand Up @@ -61,3 +61,17 @@ jobs:
env:
# to be used in case rate limits are surpassed
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
linkcheckerSphinx:
runs-on: ubuntu-latest
needs: linkCheckerLychee

steps:
# Checkout repository code
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

# Run Sphinx's linkcheck builder
- name: Run Sphinx linkcheck
run: |
sphinx-build -b linkcheck . _build/linkcheck || exit 1 #Fail the job if the link is broken
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Loading