Skip to content

Commit 259bb1e

Browse files
committed
Added RTD setup files
1 parent 9e02819 commit 259bb1e

7 files changed

Lines changed: 113 additions & 484 deletions

File tree

.github/workflows/check_links.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# =========== IMPORTANT!! READ THIS!! ============ #
2+
# This file is used to check links and can be copied to be used in other websites.
3+
4+
# When you copy this file, make sure to check and modify the fields
5+
# that here are marked with `MODIFY`.
6+
# ============================================== #
7+
8+
name: Check links
9+
10+
on:
11+
push:
12+
branches:
13+
- main
14+
pull_request:
15+
types: [opened, synchronize, reopened]
16+
workflow_dispatch:
17+
18+
jobs:
19+
check-links:
20+
uses: access-nri/access-hive-docs/.github/workflows/check_links_workflow.yml@main
21+
with:
22+
repo: '${{ github.repository }}'
23+
ref_name: "${{ github.event_name == 'pull_request' && format('refs/pull/{0}/head', github.event.pull_request.number) || github.ref_name }}"
24+
rtd_project: 'access-cm3-configs' # MODIFY: change this to the Read the Docs project
25+
python_requirements_txt: 'documentation/requirements.txt' # MODIFY: Uncomment to add requirements.txt path. If not included, 'requirements.txt' is used.
26+
mkdocs_yaml: 'documentation/mkdocs.yml' # MODIFY: Uncomment to add mkdocs.yml path. If not included, 'mkdocs.yml' is used.
27+
# lychee_config: '/path/to/lychee_config.toml' # MODIFY: Uncomment to add lychee config path. If not included, the Hive Docs' one gets used.
28+
# # MODIFY: Uncomment the lines below if the repo is private. You also need to create a secret named REPO_READ_TOKEN with a token that has repo read permissions.
29+
# secrets:
30+
# repo_read_token: ${{ secrets.REPO_READ_TOKEN }}

0 commit comments

Comments
 (0)