Add custom Sphinx documentation processing to reduce repetition and increase clarity for examples in sz-sdk-python #166
Comments
antaenc
added a commit
that referenced
this issue
Jan 20, 2025
Merged
antaenc
added a commit
that referenced
this issue
Jan 28, 2025
* #153 - Save point * #153 - Save point * #153 - Modify examples * #153 - Testing pytest failure * #153 - Testing * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Test for unittest change * #153 - Save point * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Test workflow * #153 - Save point * #153 - Save point * #153 - Save point * # 153 - Save point * # 153 - Save point * #153 - Save point * #153 - Save point * #153 - Includes #166 #161 #159 * #153 - Save point * #153 - Save point * #170 #169 #166 #161 #159 #153 * Bump twine from 6.0.1 to 6.1.0 (#168) (#172) Bumps [twine](https://github.com/pypa/twine) from 6.0.1 to 6.1.0. - [Release notes](https://github.com/pypa/twine/releases) - [Changelog](https://github.com/pypa/twine/blob/main/docs/changelog.rst) - [Commits](pypa/twine@6.0.1...6.1.0) --- updated-dependencies: - dependency-name: twine dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * #170 #169 #166 #161 #159 #153 --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Currently example code and output is in both sz-sdk-python and core/grpc causing repetition. We use the documentation from sz-sdk-python (currently) which has file references to examples in its repository.
Adding custom hooks and Python to sphinx configuration (conf.py), this allows sz-sdk-python doc strings to reference both sz-sdk-python-core and sz-sdk-python-core examples and output repository URLs to include the specific core or gRPC examples and output. It also enables sz-sdk-python-core and sz-sdk-python-core ro build their individual docs from the current branch instead of pointing to the main branch. Additional details are in the Sphinx conf.py.
The text was updated successfully, but these errors were encountered: