[CLIENT-4702] Fix several code examples in the API docs. Add smoke test to check that code examples are valid using doctest#1047

Merged

juliannguyen4 merged 121 commits into

devfrom

CLIENT-4702-doc-validate-code-examples-using-doctest

Jun 5, 2026

Commits on Apr 26, 2026

Follow quick start guide
juliannguyen4
committed
Prevent silent failing
juliannguyen4
committed
Add doctest to test code examples in aerospike module rst docs. TODO - this may make cicd check redundant in doc tests.
juliannguyen4
committed
Try running with doc/*.rst to see what files get inspected
juliannguyen4
committed
*.rst doesn't show any output. Try checking a specific file
juliannguyen4
committed
need verbose mode to see number of tests run and whether they passed
juliannguyen4
committed
Update code example to be doctest compatible. TODO - see how it appears in sphinx preview
juliannguyen4
committed
Move doctest to smoke tests to use python client build in order to import it in the code examples
juliannguyen4
committed
Reuse job that deploys server to run doctest examples
juliannguyen4
committed
Move doctest to CE test to avoid needing to login as user
juliannguyen4
committed
Do this to avoid running doc test on every python version
juliannguyen4
committed
fix workflow
juliannguyen4
committed
Add sphinx_copybutton extension to make copying doctest-formatted code examples easier
juliannguyen4
committed
Follow 'use and customize' guide for sphinx-copybutton to skip copying prompt chars
juliannguyen4
committed
Add back comments
juliannguyen4
committed
Convert all code examples to be doctest compatible TODO - except for the TLS test which needs to be run with a different job
juliannguyen4
committed
Fix doctest formatting. Not sure why sphinx didn't fail bc of this
juliannguyen4
committed

Commits on Apr 27, 2026

Commits on Apr 28, 2026

Commits on Apr 30, 2026

Commits on May 15, 2026

Commits on Jun 3, 2026

Commits on Jun 4, 2026

Use testcode block instead of doctest. Doesn't make sense to print out the zero result codes from put and append.
juliannguyen4
committed