File tree Expand file tree Collapse file tree 4 files changed +90
-295
lines changed Expand file tree Collapse file tree 4 files changed +90
-295
lines changed Original file line number Diff line number Diff line change 1
1
name : ' Build client documentation'
2
- description : ' Generates client documentation using pdoc '
2
+ description : ' Generates client documentation using sphinx '
3
3
inputs :
4
4
python-version :
5
5
description : ' Python version to use'
@@ -8,13 +8,34 @@ inputs:
8
8
runs :
9
9
using : ' composite'
10
10
steps :
11
+ - name : Pretend this project requires Python 3.11
12
+ shell : bash
13
+ run : |
14
+ # Poetry won't let me install sphinx as a dev dependency in this project
15
+ # because of the wide range of versions our library supports. So during this
16
+ # action, we'll pretend this project requires Python 3.11 or greater.
17
+ sed -i 's/python = "^3.9"/python = "^3.11"/' pyproject.toml
18
+
11
19
- name : Setup Poetry
12
20
uses : ./.github/actions/setup-poetry
13
21
with :
14
22
include_grpc : ' true'
15
23
include_dev : ' true'
24
+ include_asyncio : ' true'
16
25
python_version : ${{ inputs.python-version }}
26
+
27
+ - name : Install sphinx
28
+ shell : bash
29
+ run : |
30
+ poetry add sphinx myst-parser --group dev
31
+
17
32
- name : Build html documentation
18
33
shell : bash
19
34
run : |
20
- poetry run sphinx-build -b html sphinx docsbuild
35
+ poetry run sphinx-build -b html docs docsbuild
36
+
37
+ - name : Discard changes to pyproject.toml and poetry.lock
38
+ shell : bash
39
+ run : |
40
+ git checkout pyproject.toml
41
+ git checkout poetry.lock
Original file line number Diff line number Diff line change 14
14
- name : Checkout
15
15
uses : actions/checkout@v4
16
16
17
- - name : Generate pdoc documentation
17
+ - name : Generate sphinx documentation
18
18
uses : ./.github/actions/build-docs
19
19
with :
20
20
python-version : 3.11
You can’t perform that action at this time.
0 commit comments