aboutsummaryrefslogtreecommitdiffstats
path: root/document_endpoints.py
diff options
context:
space:
mode:
authorBlake DeMarcy <ofunknowndescent@gmail.com>2017-05-03 19:38:07 -0500
committerBlake DeMarcy <ofunknowndescent@gmail.com>2017-05-03 19:38:07 -0500
commit774d38c3f20b1f31c201926ae7c93ecf8245dd4f (patch)
tree08ec2a02f8069b3108452b7e399d66b56f801dec /document_endpoints.py
parent2fbd2396aaa8bdcbae12b7f59b6be18b4fda0ed8 (diff)
downloadbbj-774d38c3f20b1f31c201926ae7c93ecf8245dd4f.tar.gz
modify the doc script for the new annotations
Diffstat (limited to 'document_endpoints.py')
-rw-r--r--document_endpoints.py9
1 files changed, 8 insertions, 1 deletions
diff --git a/document_endpoints.py b/document_endpoints.py
index 71d2e31..ac5c874 100644
--- a/document_endpoints.py
+++ b/document_endpoints.py
@@ -118,7 +118,14 @@ for doctype in sorted(types.keys()):
body += "# %s\n\n" % doctype
funcs = sorted(types[doctype], key=lambda _: _.__name__)
for f in funcs:
- body += "## %s\n\n%s\n\n" % (f.__name__, pydoc.getdoc(f))
+ body += "## %s\n\n" % f.__name__
+ body += "### Args:\n"
+ for key, value in f.arglist:
+ if key:
+ body += "**%s**: %s\n\n" % (key, value)
+ else:
+ body += "__No arguments__"
+ body += "\n\n" + pydoc.getdoc(f) + "\n\n"
body += "\n\n--------\n\n"
with open("documentation/docs/api_overview.md", "w") as output:
Un proyecto texto-plano.xyz