Skip to content

Commit 0eb430b

Browse files
committed
docs: Migrate docs from xlnx-main
Copied from ed8775f Signed-off-by: Philip Molloy <philip@philipmolloy.com>
1 parent 1a6b1f4 commit 0eb430b

23 files changed

+1121
-0
lines changed

.github/workflows/doc.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Build documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- ci
7+
paths:
8+
- 'docs/**'
9+
pull_request:
10+
paths:
11+
- 'docs/**'
12+
13+
jobs:
14+
build-doc:
15+
runs-on: [self-hosted, repo-only]
16+
permissions:
17+
contents: read
18+
19+
steps:
20+
- uses: analogdevicesinc/doctools/checkout@action
21+
22+
- name: Install pip packages
23+
run: |
24+
python3 -m venv ~/venv
25+
source ~/venv/bin/activate
26+
pip3 install -r docs/requirements.txt --upgrade
27+
28+
- name: Build doc
29+
working-directory: docs
30+
run: |
31+
source ~/venv/bin/activate
32+
make html SPHINXOPTS='-W --keep-going'
33+
34+
- name: Store the generated doc
35+
uses: actions/upload-artifact@v4
36+
with:
37+
name: html
38+
path: docs/_build/html
39+
40+
deploy-doc:
41+
runs-on: [self-hosted, repo-only]
42+
permissions:
43+
contents: write
44+
needs: build-doc
45+
46+
steps:
47+
- uses: analogdevicesinc/doctools/gh-pages-deploy@action
48+
with:
49+
name: html
50+

docs/Makefile

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
SHELL = /bin/bash
2+
SPHINXOPTS ?=
3+
SPHINXBUILD ?= sphinx-build
4+
SOURCEDIR = .
5+
BUILDDIR = _build
6+
7+
help:
8+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
9+
10+
.PHONY: help Makefile
11+
12+
%: Makefile
13+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

0 commit comments

Comments
 (0)