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