Skip to content

Commit ba255dd

Browse files
authored
fix(ci): install SDK dependencies before docs build (#14)
* fix(docs): replace broken enterprise link with sales contact The '../../../enterprise/' relative link pointed to a non-existent folder. Replaced with mailto:sales@capisc.io as a contact point for enterprise deployment documentation. Discovered during documentation audit. * fix(ci): install sdk dependencies before docs build mkdocstrings/griffe needs pydantic and other sdk dependencies installed to resolve base classes during documentation generation. Install capiscio-sdk-python (with its deps) before requirements-docs.txt. * fix(ci): correct sdk path for GitHub Actions workspace * fix(ci): resolve griffe base class resolution errors - Install capiscio-sdk-python with [dev] extras to ensure all deps available - Move import/inventories to correct location in mkdocstrings config - Add preload_modules for pydantic to help griffe resolve base classes * ci: re-trigger build after RFC-004/005 merged to main
1 parent 7a3b1e4 commit ba255dd

2 files changed

Lines changed: 12 additions & 7 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,13 @@ jobs:
9797

9898
- name: Install dependencies
9999
run: |
100+
# Install capiscio-sdk-python with all its dependencies (pydantic, etc.)
101+
# The [dev] extra ensures all optional deps are available for mkdocstrings
102+
pip install -e "capiscio-sdk-python[dev]"
103+
104+
# Now install docs requirements
100105
cd capiscio-docs
101106
pip install -r requirements-docs.txt
102-
# Install capiscio-sdk-python in editable mode for mkdocstrings to resolve types
103-
pip install -e ../capiscio-sdk-python
104107
105108
- name: Build documentation
106109
run: |

mkdocs.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,19 +79,21 @@ plugins:
7979
handlers:
8080
python:
8181
paths: ["../capiscio-sdk-python"]
82+
import:
83+
# Enable cross-references to Python stdlib and pydantic
84+
- https://docs.python.org/3/objects.inv
85+
- https://docs.pydantic.dev/latest/objects.inv
8286
options:
8387
show_source: false
8488
show_root_heading: true
8589
show_signature_annotations: true
8690
separate_signature: true
8791
docstring_style: google
8892
members_order: source
89-
# Allow unresolved references for external types (Exception, pydantic.BaseModel, etc.)
9093
show_if_no_docstring: false
91-
inventories:
92-
# Enable cross-references to Python stdlib and pydantic
93-
- https://docs.python.org/3/objects.inv
94-
- https://docs.pydantic.dev/latest/objects.inv
94+
# Preload pydantic to resolve base classes
95+
preload_modules:
96+
- pydantic
9597

9698
markdown_extensions:
9799
- admonition

0 commit comments

Comments
 (0)