Skip to content

Commit b40d7e8

Browse files
ErikDeSmedtcdecker
authored andcommitted
Include typehints in pdoc
We use pdoc to generate a reference of the python `glclient`-library. We suffered some issues related to missing type-hints. The work-around was to remove the type-hints before generating the docs. I've found 3 causes of warnings. 1. Missing export of `SignerHandle` (See #368) 2. Poorly defined imports in auto-generated GRPC-code (See #369) 3. pdoc failing to import type from type-stubs (See mitmproxy/pdoc#671) All of these 3 issues have been addressed so we don't need the hack anymore.
1 parent 76297c5 commit b40d7e8

File tree

1 file changed

+0
-1
lines changed

1 file changed

+0
-1
lines changed

.github/workflows/docs-action.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ jobs:
7171
DOCSREMOTE: "origin"
7272
GITHUB_TOKEN: "${{ secrets.GH_PAGES_PAT }}"
7373
run: |
74-
rm libs/gl-client-py/glclient/*.pyi
7574
PATH=$(pwd)/.venv/bin:$PATH make docs
7675
7776
- name: Deploy

0 commit comments

Comments
 (0)