Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,13 @@ jobs:

- name: Install dependencies
run: |
# Install capiscio-sdk-python with all its dependencies (pydantic, etc.)
# The [dev] extra ensures all optional deps are available for mkdocstrings
pip install -e "capiscio-sdk-python[dev]"

# Now install docs requirements
cd capiscio-docs
pip install -r requirements-docs.txt
# Install capiscio-sdk-python in editable mode for mkdocstrings to resolve types
pip install -e ../capiscio-sdk-python

- name: Build documentation
run: |
Expand Down
12 changes: 7 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,19 +79,21 @@ plugins:
handlers:
python:
paths: ["../capiscio-sdk-python"]
import:
# Enable cross-references to Python stdlib and pydantic
- https://docs.python.org/3/objects.inv
- https://docs.pydantic.dev/latest/objects.inv
options:
show_source: false
show_root_heading: true
show_signature_annotations: true
separate_signature: true
docstring_style: google
members_order: source
# Allow unresolved references for external types (Exception, pydantic.BaseModel, etc.)
show_if_no_docstring: false
inventories:
# Enable cross-references to Python stdlib and pydantic
- https://docs.python.org/3/objects.inv
- https://docs.pydantic.dev/latest/objects.inv
# Preload pydantic to resolve base classes
preload_modules:
- pydantic

markdown_extensions:
- admonition
Expand Down