Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: documentation for initial stable release of algorand-python-testing #8

Merged
merged 11 commits into from
Aug 21, 2024

Conversation

aorumbayev
Copy link
Collaborator

@aorumbayev aorumbayev commented Jul 30, 2024

Proposed Changes

  • Revamps documentation by introducing a more structure set of sections mirroring the documentation of puya docs
  • Integrating autodoc2 with autogeneration of docs for algopy_testing folder

TODO

  • - Integrate autodoc2, and doctests to validate code snippets in the docs and split large doc files to increase maintainability
  • - Update contracts sections with more examples
  • - Update ops sections with more examples

Notes

To review locally, checkout the branch and execute hatch run docs:dev to preview from localhost

@aorumbayev aorumbayev force-pushed the docs/improving-docs branch 2 times, most recently from 720ad66 to b547249 Compare August 1, 2024 18:48
@aorumbayev aorumbayev marked this pull request as ready for review August 3, 2024 11:57
@aorumbayev aorumbayev changed the base branch from main to feat/state_ops August 3, 2024 11:59
@aorumbayev
Copy link
Collaborator Author

@daniel-makerx i'm rebasing this against state ops branch to make PR review a bit simpler, also moved all non docs changes from here to state ops to avoid patching merge conflicts between these 2 branches on each non docs folder related change. Main gist is ready for review - a few sections are missing with examples which ill add in addition on Monday.

Also did minor tweaks in the way scratch space is handled - see my last commit on sate ops branch (also covered in the dedicated section under state management on these new docs)

@aorumbayev aorumbayev changed the title refactor: improving documentation; adding minor extra helpers to context refactor: preparing documentation for algorand-python-testing initial release Aug 3, 2024
docs/coverage.md Outdated Show resolved Hide resolved
docs/glossary.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@aorumbayev aorumbayev changed the title refactor: preparing documentation for algorand-python-testing initial release docs: preparing documentation for algorand-python-testing initial release Aug 5, 2024
@aorumbayev aorumbayev changed the title docs: preparing documentation for algorand-python-testing initial release docs: documentation for initial stable release of algorand-python-testing Aug 12, 2024
Base automatically changed from feat/state_ops to main August 13, 2024 23:55
@aorumbayev aorumbayev marked this pull request as draft August 19, 2024 01:12
aorumbayev and others added 2 commits August 21, 2024 13:02
Co-authored-by: Daniel McGregor <daniel.mcgregor@makerx.com.au>
@aorumbayev aorumbayev merged commit 9d97d0d into main Aug 21, 2024
1 check passed
@aorumbayev aorumbayev deleted the docs/improving-docs branch August 21, 2024 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants