Skip to content

Commit

Permalink
refactor: adding autodoc for test context
Browse files Browse the repository at this point in the history
  • Loading branch information
aorumbayev committed Jul 31, 2024
1 parent 1e066f9 commit 720ad66
Show file tree
Hide file tree
Showing 7 changed files with 138 additions and 99 deletions.
3 changes: 3 additions & 0 deletions docs/api-algopy-testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```{autodoc2-object} algopy_testing.context
render_plugin = "myst"
```
9 changes: 9 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# API Reference

```{toctree}
---
maxdepth: 4
---
api-algopy-testing
```
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"sphinx.ext.napoleon",
"sphinx_copybutton",
"myst_parser",
"sphinx.ext.napoleon",
"autodoc2", # Add this line
]

Expand Down Expand Up @@ -72,10 +73,9 @@
},
]
autodoc2_render_plugin = "myst"
# autodoc2_module_all_regexes = [r"algopy_testing.*"]
autodoc2_hidden_objects = [
"private", # single-underscore methods, e.g. _private
# "undoc",
"undoc",
]
add_module_names = False
autodoc2_index_template = None
2 changes: 0 additions & 2 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,8 +324,6 @@ from algopy import arc4
string_value = arc4.String("Hello, Algorand!")
```

Certainly! I'll explain the `execute_logicsig` method from the `AlgopyTestContext` class and expand the documentation for smart signatures. Here's an updated version of the smart signatures section in the usage documentation:

## Smart Signatures (Logic Signatures)

Smart signatures, also known as logic signatures or LogicSigs, are programs that can be used to sign transactions. The Algorand Python Testing framework provides support for testing these programs.
Expand Down
Loading

0 comments on commit 720ad66

Please sign in to comment.