-Generating Documentation -(slides) +Generating Documentation +(slides)
doc_sampleDocstring for module.
+doc_sample.SampleDocstring for class.
+doc_sample.Sample.__init__Docstring for constructor.
+doc_sample.Sample.renameDocstring for method.
+doc_sample.functionDocstring for function.
+doc_sample.undocumentedNo documentation.
diff --git a/src/docs/doc_sample.py b/src/docgen/doc_sample.py similarity index 100% rename from src/docs/doc_sample.py rename to src/docgen/doc_sample.py diff --git a/src/docs/double_and_print.py b/src/docgen/double_and_print.py similarity index 100% rename from src/docs/double_and_print.py rename to src/docgen/double_and_print.py diff --git a/src/docs/index.md b/src/docgen/index.md similarity index 100% rename from src/docs/index.md rename to src/docgen/index.md diff --git a/src/docs/inject.py b/src/docgen/inject.py similarity index 100% rename from src/docs/inject.py rename to src/docgen/inject.py diff --git a/src/docgen/inject_exec.out b/src/docgen/inject_exec.out new file mode 100644 index 00000000..605d6e35 --- /dev/null +++ b/src/docgen/inject_exec.out @@ -0,0 +1 @@ +Counter({'add': 2, 'double': 1}) diff --git a/src/docs/inject_exec.sh b/src/docgen/inject_exec.sh similarity index 100% rename from src/docs/inject_exec.sh rename to src/docgen/inject_exec.sh diff --git a/src/docgen/inject_make.out b/src/docgen/inject_make.out new file mode 100644 index 00000000..daeea15e --- /dev/null +++ b/src/docgen/inject_make.out @@ -0,0 +1,6 @@ +Expr( + value=Call( + func=Name(id='count', ctx=Load()), + args=[ + Constant(value='test')], + keywords=[])) diff --git a/src/docs/inject_make.sh b/src/docgen/inject_make.sh similarity index 100% rename from src/docs/inject_make.sh rename to src/docgen/inject_make.sh diff --git a/src/docgen/inject_modified.out b/src/docgen/inject_modified.out new file mode 100644 index 00000000..5e835b68 --- /dev/null +++ b/src/docgen/inject_modified.out @@ -0,0 +1,9 @@ +def add(left, right): + count('add') + return left + right + +def double(x): + count('double') + return add(x, x) +add(1, 2) +double(3) diff --git a/src/docs/inject_modified.sh b/src/docgen/inject_modified.sh similarity index 100% rename from src/docs/inject_modified.sh rename to src/docgen/inject_modified.sh diff --git a/src/docgen/inject_parse.out b/src/docgen/inject_parse.out new file mode 100644 index 00000000..f01f6adb --- /dev/null +++ b/src/docgen/inject_parse.out @@ -0,0 +1,9 @@ +Module( + body=[ + Expr( + value=Call( + func=Name(id='count', ctx=Load()), + args=[ + Constant(value='name')], + keywords=[]))], + type_ignores=[]) diff --git a/src/docs/inject_parse.sh b/src/docgen/inject_parse.sh similarity index 100% rename from src/docs/inject_parse.sh rename to src/docgen/inject_parse.sh diff --git a/src/docs/unparse.py b/src/docgen/unparse.py similarity index 100% rename from src/docs/unparse.py rename to src/docgen/unparse.py diff --git a/src/docgen/unparse_exec.out b/src/docgen/unparse_exec.out new file mode 100644 index 00000000..91dea2c7 --- /dev/null +++ b/src/docgen/unparse_exec.out @@ -0,0 +1,2 @@ +6 +6 diff --git a/src/docs/unparse_exec.sh b/src/docgen/unparse_exec.sh similarity index 100% rename from src/docs/unparse_exec.sh rename to src/docgen/unparse_exec.sh diff --git a/src/docgen/unparse_modified.out b/src/docgen/unparse_modified.out new file mode 100644 index 00000000..d4fc1d56 --- /dev/null +++ b/src/docgen/unparse_modified.out @@ -0,0 +1,4 @@ +def double(x): + return 2 * x +print(double(3)) +print(double(3)) diff --git a/src/docs/unparse_modified.sh b/src/docgen/unparse_modified.sh similarity index 100% rename from src/docs/unparse_modified.sh rename to src/docgen/unparse_modified.sh