FilesExpand file tree

master

/

docs.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

114 lines (94 loc) · 3.03 KB

master

/

docs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

114 lines (94 loc) · 3.03 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

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

name: Documentation

on:

push:

tags: ['v**']

workflow_dispatch:

permissions:

contents: read

jobs:

live-examples:

name: Live documentation examples

if: >-

github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v')

runs-on: ubuntu-latest

timeout-minutes: 30

steps:

- uses: actions/checkout@v6

- uses: actions/setup-python@v6

with:

python-version: "3.13"

- uses: astral-sh/setup-uv@v7

- name: Install test dependencies

run: |

uv venv

uv pip install -e '.[test]'

- name: Run live documentation examples

run: >-

.venv/bin/python -m pytest tests/test_docs_examples.py

--require-docs-key -q --junitxml=docs-example-results.xml

env:

API_KEY: ${{ secrets.API_KEY }}

- uses: actions/upload-artifact@v7

if: always()

with:

name: docs-example-results

path: docs-example-results.xml

if-no-files-found: warn

build:

name: Build Sphinx documentation

needs: [live-examples]

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v6

- uses: actions/setup-python@v6

with:

python-version: "3.13"

- uses: astral-sh/setup-uv@v7

- name: Install documentation dependencies

run: |

uv venv

uv pip install -e '.[docs,test]'

- name: Test documentation publishing

run: .venv/bin/python -m pytest tests/test_docs_publishing.py -q

- name: Check documentation code and test runner without API calls

run: >-

.venv/bin/python -m pytest tests/test_docs_examples.py

tests/test_docs_example_runner.py -k 'not live' -q

- name: Build HTML documentation

run: .venv/bin/sphinx-build -M html docs docs/_build -W --keep-going

- name: Build EPUB documentation

run: .venv/bin/sphinx-build -M epub docs docs/_build -W --keep-going

- uses: actions/upload-artifact@v7

with:

name: documentation

path: docs/_build/

if-no-files-found: error

publish:

name: Publish Read the Docs

needs: [live-examples, build]

if: >-

needs.live-examples.result == 'success' &&

needs.build.result == 'success' &&

(github.event_name == 'push' || github.event_name == 'workflow_dispatch') &&

(github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v'))

runs-on: ubuntu-latest

timeout-minutes: 60

environment:

name: docs

url: https://serpapi-python.readthedocs.io/

concurrency:

group: readthedocs-publish

cancel-in-progress: false

queue: max

steps:

- uses: actions/checkout@v6

with:

ref: ${{ github.sha }}

persist-credentials: false

- uses: actions/setup-python@v6

with:

python-version: "3.13"

- name: Sync versions, publish, and wait for RTD

run: python -m scripts.publish_docs

env:

RTD_API_TOKEN: ${{ secrets.RTD_API_TOKEN }}