API documentation with Sphinx configuration and workflows#154
Open
marcos-sinch wants to merge 6 commits into
Open
API documentation with Sphinx configuration and workflows#154marcos-sinch wants to merge 6 commits into
marcos-sinch wants to merge 6 commits into
Conversation
marcos-sinch
requested review from
Hurus111,
JPPortier,
asein-sinch,
edu-sinch and
matsk-sinch
as code owners
matsk-sinch
reviewed
Jun 11, 2026
| pydantic >= 2.0.0 | ||
|
|
||
| # Documentation | ||
| sphinx |
Contributor
There was a problem hiding this comment.
what do you think of pinning a version? because of sphinx.ext.apidoc
| # -- Project information ------------------------------------------------------- | ||
|
|
||
| project = "Sinch Python SDK" | ||
| copyright = "2024, Sinch Developer Experience Team" |
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
2 participants
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.
Adds API documentation generation with Sphinx (autodoc from docstrings) and the documentation-upload.yaml workflow that, on release, builds it, packages it, and uploads it to the GitLab Package Registry
Includes make docs to build it locally and the required dependencies in requirements-dev.txt.
Jira: DEVEXP-831