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: sphinx, autodoc2, doctests setup #2

Merged
merged 2 commits into from
Sep 18, 2024
Merged

docs: sphinx, autodoc2, doctests setup #2

merged 2 commits into from
Sep 18, 2024

Conversation

aorumbayev
Copy link
Contributor

Proposed Changes

  • Adding docs using similar setup/theme as puya repos

@aorumbayev
Copy link
Contributor Author

@joe-p a lot of docstrings are still not reST styled, for better rendering by sphinx please change those from google style to the rest.

The header of index.md file in docs demonstrates an example of a doctest (in that case the snippet for launching the library in quickstart has actual code that doctests execute as part of poetry run poe docs-test) - that way you can have extra confidence that each snippet in docs is a valid code ready to be copy pasted for use. Feel free to expand remaining snippets to be runnable chunks of python code as well.

@aorumbayev
Copy link
Contributor Author

Would also suggest adding contributing MD and integrating semantic releases bot (for semantic releases bot specifically you can find many references on algokit cli, utils py, generator py, puya and puya unit testing repos)

@joe-p joe-p merged commit eaaad5f into dev Sep 18, 2024
2 checks passed
@joe-p
Copy link
Contributor

joe-p commented Sep 18, 2024

Amazing thanks @aorumbayev!

@joe-p joe-p deleted the docs branch September 19, 2024 16:14
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