Skip to content

Commit 9064a11

Browse files
committed
Update SC_PythonAPI_documentation with latest changes
1 parent 41dbcd1 commit 9064a11

File tree

9 files changed

+753
-19
lines changed

9 files changed

+753
-19
lines changed

custom_templates/base.html

Lines changed: 0 additions & 17 deletions
This file was deleted.

custom_templates/config.mako

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<%!
2+
# Template configuration. Copy over in your template directory
3+
# (used with `--template-dir`) and adapt as necessary.
4+
# Note, defaults are loaded from this distribution file, so your
5+
# config.mako only needs to contain values you want overridden.
6+
# You can also run pdoc with `--config KEY=VALUE` to override
7+
# individual values.
8+
9+
html_lang = 'en'
10+
show_inherited_members = False
11+
extract_module_toc_into_sidebar = True
12+
list_class_variables_in_index = True
13+
sort_identifiers = False
14+
show_type_annotations = True
15+
16+
# Show collapsed source code block next to each item.
17+
# Disabling this can improve rendering speed of large modules.
18+
show_source_code = True
19+
20+
# If set, format links to objects in online source code repository
21+
# according to this template. Supported keywords for interpolation
22+
# are: commit, path, start_line, end_line.
23+
#git_link_template = 'https://github.com/USER/PROJECT/blob/{commit}/{path}#L{start_line}-L{end_line}'
24+
#git_link_template = 'https://gitlab.com/USER/PROJECT/blob/{commit}/{path}#L{start_line}-L{end_line}'
25+
#git_link_template = 'https://bitbucket.org/USER/PROJECT/src/{commit}/{path}#lines-{start_line}:{end_line}'
26+
#git_link_template = 'https://CGIT_HOSTNAME/PROJECT/tree/{path}?id={commit}#n{start-line}'
27+
git_link_template = None
28+
29+
# A prefix to use for every HTML hyperlink in the generated documentation.
30+
# No prefix results in all links being relative.
31+
link_prefix = ''
32+
33+
# Enable syntax highlighting for code/source blocks by including Highlight.js
34+
syntax_highlighting = True
35+
36+
# Set the style keyword such as 'atom-one-light' or 'github-gist'
37+
# Options: https://github.com/highlightjs/highlight.js/tree/master/src/styles
38+
# Demo: https://highlightjs.org/static/demo/
39+
hljs_style = 'default'
40+
41+
# If set, insert Google Analytics 4 tracking code. Value is GA
42+
# tracking id (G-XXXXXXXXXX).
43+
google_analytics = ''
44+
45+
# If set, insert Google Custom Search search bar widget above the sidebar index.
46+
# The whitespace-separated tokens represent arbitrary extra queries (at least one
47+
# must match) passed to regular Google search. Example:
48+
#google_search_query = 'inurl:github.com/USER/PROJECT site:PROJECT.github.io site:PROJECT.website'
49+
google_search_query = ''
50+
51+
# Enable offline search using Lunr.js. For explanation of 'fuzziness' parameter, which is
52+
# added to every query word, see: https://lunrjs.com/guides/searching.html#fuzzy-matches
53+
# If 'index_docstrings' is False, a shorter index is built, indexing only
54+
# the full object reference names.
55+
#lunr_search = {'fuzziness': 1, 'index_docstrings': True}
56+
lunr_search = None
57+
58+
# If set, render LaTeX math syntax within \(...\) (inline equations),
59+
# or within \[...\] or $$...$$ or `.. math::` (block equations)
60+
# as nicely-formatted math formulas using MathJax.
61+
# Note: in Python docstrings, either all backslashes need to be escaped (\\)
62+
# or you need to use raw r-strings.
63+
latex_math = False
64+
65+
# Additional markdown extensions to enable. See:
66+
# https://python-markdown.github.io/extensions/
67+
# https://python-markdown.github.io/reference/#extensions
68+
# https://github.com/Python-Markdown/markdown/wiki/Third-Party-Extensions
69+
md_extensions = {'extensions': [], 'configs': {}}
70+
%>

custom_templates/head.mako

Whitespace-only changes.

0 commit comments

Comments
 (0)