FilesExpand file tree

main

/

docs.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

48 lines (44 loc) · 1.06 KB

main

/

docs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

48 lines (44 loc) · 1.06 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

# SPDX-FileCopyrightText: 2023 spdx contributors

#

# SPDX-License-Identifier: Apache-2.0

name: Generate API docs

on:

push:

branches:

- main

workflow_dispatch:

permissions:

contents: read

jobs:

build:

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v3

- name: Setup Python

uses: actions/setup-python@v4

with:

python-version: '3.14'

- name: Install dependencies

run: |

sudo apt-get install graphviz-dev

pip install -e ".[test,graph_generation]"

pip install pdoc

- name: Generate docs

run: pdoc spdx_tools -o docs/

- name: Upload docs as artifact

uses: actions/upload-pages-artifact@v3

with:

path: docs/

deploy:

needs: build

runs-on: ubuntu-latest

permissions:

pages: write

id-token: write

environment:

name: github-pages

url: ${{ steps.deployment.outputs.page_url }}

steps:

- id: deployment

name: Deploy docs to GitHub pages

uses: actions/deploy-pages@v4