docs: add documentation for more stubs (#88)

algorandfoundation · Feb 9, 2024 · 2668623 · 2668623
1 parent 6ca27aa
commit 2668623
Show file tree

Hide file tree

Showing 9 changed files with 513 additions and 176 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -16,6 +16,7 @@
 extensions = [
     "sphinx.ext.githubpages",
     "sphinx.ext.intersphinx",
+    "sphinx_copybutton",
     "myst_parser",
     "autodoc2",
 ]
@@ -33,12 +34,11 @@
     "autodoc2.dup_item",
 ]
 nitpick_ignore = [
-    ("py:class", "puyapy._T"),
-    ("py:class", "puyapy._P"),
-    ("py:class", "puyapy._R"),
-    ("py:class", "puyapy.arc4._T"),
-    ("py:class", "puyapy.arc4._TArrayItem"),
-    ("py:class", "puyapy.arc4._TTuple"),
+    ("py:class", "puyapy.arc4.AllowedOnCompletes"),
+]
+nitpick_ignore_regex = [
+    ("py:class", r"puyapy\._.*"),
+    ("py:class", r"puyapy\.arc4\._.*"),
 ]
 
 # -- Options for HTML output -------------------------------------------------
@@ -68,9 +68,10 @@
 autodoc2_hidden_objects = [
     "private",  # single-underscore methods, e.g. _private
     "undoc",
+    "inherited",
 ]
 autodoc2_class_inheritance = False
-autodoc2_module_all_regexes = [r"puyapy"]
+autodoc2_module_all_regexes = [r"puyapy.*"]
 autodoc2_render_plugin = "myst"
 autodoc2_sort_names = True
 autodoc2_index_template = None
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -54,6 +54,7 @@ sphinx = "^7.2.6"
 furo = "^2024.1.29"
 myst-parser = "^2.0.0"
 sphinx-autodoc2 = "^0.5.0"
+sphinx-copybutton = "^0.5.2"
 
 [tool.poetry.group.cicd]
 optional = true