Skip to content

Commit abbe2ab

Browse files
committed
Add automated check for docs build
1 parent a55e18a commit abbe2ab

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@ Before submitting this PR, please make sure (put X in square brackets):
3131
- [ ] I have necessary comments in my code, particularly in hard-to-understand areas.
3232
- [ ] I have run end-to-end tests tests and provided workload links above if applicable.
3333
- [ ] I have made or will make corresponding changes to the doc if needed.
34+
- [ ] I have added any new documentation pages to [the relevant toctree](https://maxtext.readthedocs.io/en/latest/development.html#adding-new-documentation-files).
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Check the Documentation Build
2+
3+
on:
4+
pull_request:
5+
types: [opened, synchronize]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
11+
jobs:
12+
build-docs:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout repository
16+
uses: actions/checkout@v5
17+
18+
- name: Set up Python
19+
uses: actions/setup-python@v5
20+
with:
21+
python-version: '3.11'
22+
cache: 'pip' # caching pip dependencies
23+
24+
- name: Install dependencies
25+
run: pip install -r requirements_docs.txt
26+
27+
- name: Build documentation
28+
run: |
29+
sphinx-build -b html docs/ docs/_build/html

0 commit comments

Comments
 (0)