aboutsummaryrefslogtreecommitdiff
path: root/python/pyarmnn/docs_conf
diff options
context:
space:
mode:
authorRichard Burton <richard.burton@arm.com>2020-04-08 16:39:05 +0100
committerJim Flynn <jim.flynn@arm.com>2020-04-10 16:11:09 +0000
commitdc0c6ed9f8b993e63f492f203d7d7080ab4c835c (patch)
treeea8541990b13ebf1a038009aa6b8b4b1ea8c3f55 /python/pyarmnn/docs_conf
parentfe5a24beeef6e9a41366e694f41093565e748048 (diff)
downloadarmnn-dc0c6ed9f8b993e63f492f203d7d7080ab4c835c.tar.gz
Add PyArmNN to work with ArmNN API of 20.02
* Add Swig rules for generating python wrapper * Add documentation * Add tests and testing data Change-Id: If48eda08931514fa21e72214dfead2835f07237c Signed-off-by: Richard Burton <richard.burton@arm.com> Signed-off-by: Derek Lamberti <derek.lamberti@arm.com>
Diffstat (limited to 'python/pyarmnn/docs_conf')
-rw-r--r--python/pyarmnn/docs_conf/config.mako34
1 files changed, 34 insertions, 0 deletions
diff --git a/python/pyarmnn/docs_conf/config.mako b/python/pyarmnn/docs_conf/config.mako
new file mode 100644
index 0000000000..b26003bd53
--- /dev/null
+++ b/python/pyarmnn/docs_conf/config.mako
@@ -0,0 +1,34 @@
+<%!
+ # Template configuration. Copy over in your template directory
+ # (used with --template-dir) and adapt as required.
+ html_lang = 'en'
+ show_inherited_members = True
+ extract_module_toc_into_sidebar = True
+ list_class_variables_in_index = True
+ sort_identifiers = True
+ show_type_annotations = False
+
+ # Show collapsed source code block next to each item.
+ # Disabling this can improve rendering speed of large modules.
+ show_source_code = False
+
+ # A prefix to use for every HTML hyperlink in the generated documentation.
+ # No prefix results in all links being relative.
+ link_prefix = ''
+
+ # Set the style keyword such as 'atom-one-light' or 'github-gist'
+ # Options: https://github.com/highlightjs/highlight.js/tree/master/src/styles
+ # Demo: https://highlightjs.org/static/demo/
+ hljs_style = 'github'
+
+ # If set, insert Google Analytics tracking code. Value is GA
+ # tracking id (UA-XXXXXX-Y).
+ google_analytics = ''
+
+ # If set, render LaTeX math syntax within \(...\) (inline equations),
+ # or within \[...\] or $$...$$ or `.. math::` (block equations)
+ # as nicely-formatted math formulas using MathJax.
+ # Note: in Python docstrings, either all backslashes need to be escaped (\\)
+ # or you need to use raw r-strings.
+ latex_math = True
+%>