fix(ci): install SDK dependencies before docs build#14
Merged
Conversation
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.
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.
- 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
✅ Documentation Build SuccessfulThe documentation build completed successfully and passed validation checks.
|
✅ Documentation Build SuccessfulThe documentation build completed successfully and passed validation checks.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes mkdocstrings/griffe resolution errors during documentation build.
Problem
The docs CI was failing because
mkdocstrings/griffecould not resolve base classes likeException,enum.Enum,str, orpydantic.BaseModelwhen documenting Python code fromcapiscio-sdk-python.Solution
Install
capiscio-sdk-python(with its dependencies like pydantic) before installingrequirements-docs.txt. This ensures mkdocstrings/griffe can resolve all base classes during documentation generation.Changes
.github/workflows/deploy.ymlTesting
The
--strictflag onmkdocs buildwill validate that all type references resolve correctly.