1*89c4ff92SAndroid Build Coastguard Worker## 2*89c4ff92SAndroid Build Coastguard Worker## Copyright © 2020 Arm Ltd and Contributors. All rights reserved. 3*89c4ff92SAndroid Build Coastguard Worker## SPDX-License-Identifier: MIT 4*89c4ff92SAndroid Build Coastguard Worker## 5*89c4ff92SAndroid Build Coastguard Worker<%! 6*89c4ff92SAndroid Build Coastguard Worker # Template configuration. Copy over in your template directory 7*89c4ff92SAndroid Build Coastguard Worker # (used with --template-dir) and adapt as required. 8*89c4ff92SAndroid Build Coastguard Worker html_lang = 'en' 9*89c4ff92SAndroid Build Coastguard Worker show_inherited_members = True 10*89c4ff92SAndroid Build Coastguard Worker extract_module_toc_into_sidebar = True 11*89c4ff92SAndroid Build Coastguard Worker list_class_variables_in_index = True 12*89c4ff92SAndroid Build Coastguard Worker sort_identifiers = True 13*89c4ff92SAndroid Build Coastguard Worker show_type_annotations = False 14*89c4ff92SAndroid Build Coastguard Worker 15*89c4ff92SAndroid Build Coastguard Worker # Show collapsed source code block next to each item. 16*89c4ff92SAndroid Build Coastguard Worker # Disabling this can improve rendering speed of large modules. 17*89c4ff92SAndroid Build Coastguard Worker show_source_code = False 18*89c4ff92SAndroid Build Coastguard Worker 19*89c4ff92SAndroid Build Coastguard Worker # A prefix to use for every HTML hyperlink in the generated documentation. 20*89c4ff92SAndroid Build Coastguard Worker # No prefix results in all links being relative. 21*89c4ff92SAndroid Build Coastguard Worker link_prefix = '' 22*89c4ff92SAndroid Build Coastguard Worker 23*89c4ff92SAndroid Build Coastguard Worker # Set the style keyword such as 'atom-one-light' or 'github-gist' 24*89c4ff92SAndroid Build Coastguard Worker # Options: https://github.com/highlightjs/highlight.js/tree/master/src/styles 25*89c4ff92SAndroid Build Coastguard Worker # Demo: https://highlightjs.org/static/demo/ 26*89c4ff92SAndroid Build Coastguard Worker hljs_style = 'github' 27*89c4ff92SAndroid Build Coastguard Worker 28*89c4ff92SAndroid Build Coastguard Worker # If set, insert Google Analytics tracking code. Value is GA 29*89c4ff92SAndroid Build Coastguard Worker # tracking id (UA-XXXXXX-Y). 30*89c4ff92SAndroid Build Coastguard Worker google_analytics = '' 31*89c4ff92SAndroid Build Coastguard Worker 32*89c4ff92SAndroid Build Coastguard Worker # If set, render LaTeX math syntax within \(...\) (inline equations), 33*89c4ff92SAndroid Build Coastguard Worker # or within \[...\] or $$...$$ or `.. math::` (block equations) 34*89c4ff92SAndroid Build Coastguard Worker # as nicely-formatted math formulas using MathJax. 35*89c4ff92SAndroid Build Coastguard Worker # Note: in Python docstrings, either all backslashes need to be escaped (\\) 36*89c4ff92SAndroid Build Coastguard Worker # or you need to use raw r-strings. 37*89c4ff92SAndroid Build Coastguard Worker latex_math = True 38*89c4ff92SAndroid Build Coastguard Worker%> 39