feat: optimize pdoc workflow and deps installation

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.

.forgejo/workflows/pdoc.yml

@@ -26,9 +26,9 @@ jobs:
 
       - name: Install Python dependencies
         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
         with:

.gitignore

@@ -5,4 +5,5 @@
 
 # Directories
 __pycache__/
-venv/
+venv/
+docs/

src/plankapy/plankapy.py

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