Skip to content

Commit bdd398a

Browse files
authored
Investigate (and fix) documentation (#445)
1 parent 96910a9 commit bdd398a

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

.github/workflows/pdoc.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@ jobs:
2626
python-version: 3.12
2727
- name: Build
2828
run: |
29-
echo "PDOC_GENERATE_PYPARTMC_DOCS=True" >> $GITHUB_ENV
3029
pip install pdoc
3130
pip install -e .
32-
PDOC_ALLOW_EXEC=1 python -We -m pdoc -o html PyPartMC
31+
PDOC_ALLOW_EXEC=1 PDOC_GENERATE_PYPARTMC_DOCS=1 python -We -m pdoc -o html PyPartMC
3332
- name: Deploy
3433
if: ${{ github.ref == 'refs/heads/main' && matrix.platform == 'ubuntu-latest' }}
3534
uses: JamesIves/[email protected]

src/PyPartMC/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ def __generate_si():
8787
# docs would be listed as nanobind objects with no additional documentation.
8888
# To solve that, dummy functions of the same name are created, and their "__doc__"
8989
# attribute is manually set to the "original" objects' "__doc__"
90-
if os.getenv("PDOC_GENERATE_PYPARTMC_DOCS") == "True":
90+
if os.getenv("PDOC_GENERATE_PYPARTMC_DOCS") == "1":
9191
all_items = []
9292
for name, obj in inspect.getmembers(
9393
_PyPartMC # pylint: disable=undefined-variable

0 commit comments

Comments
 (0)