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 11name : ' Build client documentation'
2- description : ' Generates client documentation using pdoc '
2+ description : ' Generates client documentation using sphinx '
33inputs :
44 python-version :
55 description : ' Python version to use'
@@ -8,13 +8,34 @@ inputs:
88runs :
99 using : ' composite'
1010 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+
1119 - name : Setup Poetry
1220 uses : ./.github/actions/setup-poetry
1321 with :
1422 include_grpc : ' true'
1523 include_dev : ' true'
24+ include_asyncio : ' true'
1625 python_version : ${{ inputs.python-version }}
26+
27+ - name : Install sphinx
28+ shell : bash
29+ run : |
30+ poetry add sphinx myst-parser --group dev
31+
1732 - name : Build html documentation
1833 shell : bash
1934 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 1414 - name : Checkout
1515 uses : actions/checkout@v4
1616
17- - name : Generate pdoc documentation
17+ - name : Generate sphinx documentation
1818 uses : ./.github/actions/build-docs
1919 with :
2020 python-version : 3.11
You can’t perform that action at this time.
0 commit comments