feat: optimize pdoc workflow and deps installation
Some checks failed
website / build (push) Failing after 20s

Reworked the Python dependency installation step in the `.forgejo/workflows/pdoc.yml` workflow file to install from the current directory (`.`) instead of specifying packages directly. This adjustment ensures that local package dependencies are correctly resolved and installed, aligning with best practices for Python projects. Additionally, streamlined the documentation generation process by modifying the `pdoc` execution command to use the package's dot notation, improving clarity and consistency in how the `pdoc` tool is invoked for generating Markdown documentation.

This change enhances the maintainability of our documentation workflow and ensures that our environment mirrors production more closely, potentially reducing the occurrence of "works on my machine" issues.
This commit is contained in:
Kumi 2024-04-25 08:58:31 +02:00
parent 4f3159b3fa
commit a0cc7a742b
Signed by: kumi
GPG key ID: ECBCC9082395383F
3 changed files with 5 additions and 4 deletions

View file

@ -26,9 +26,9 @@ jobs:
- name: Install Python dependencies - name: Install Python dependencies
run: | run: |
pip install pdoc requests --break-system-packages pip install pdoc . --break-system-packages
- run: python3 -m pdoc -d markdown -o docs src/plankapy/plankapy.py - run: python3 -m pdoc -d markdown -o docs plankapy
- uses: forgejo/upload-artifact@v4 - uses: forgejo/upload-artifact@v4
with: with:

1
.gitignore vendored
View file

@ -6,3 +6,4 @@
# Directories # Directories
__pycache__/ __pycache__/
venv/ venv/
docs/

View file

@ -264,7 +264,7 @@ class Board(Controller):
def get( def get(
self, self,
project_name: Optional[str] = None, project_name: Optional[str] = None,
board_name: Optionoal[str] = None, board_name: Optional[str] = None,
oid: Optional[str] = None, oid: Optional[str] = None,
) -> dict: ) -> dict:
"""Gets a board by name """Gets a board by name