1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
# pylint: disable=C0103
"""Configuration file for the Sphinx documentation builder."""
import os
import shutil
import sys
sys.path.append(os.path.join(os.path.dirname(__file__), "..", "_common"))
# import recommonmark
# -- Project information -----------------------------------------------------
project = "Python API"
copyright = "2018-2024, Microsoft"
author = "Microsoft"
# -- General configuration ---------------------------------------------------
extensions = [
"sphinx.ext.intersphinx",
"sphinx.ext.imgmath",
"sphinx.ext.ifconfig",
"sphinx.ext.viewcode",
"sphinx.ext.autodoc",
"sphinx.ext.githubpages",
"sphinx_gallery.gen_gallery",
"sphinx.ext.graphviz",
"pyquickhelper.sphinxext.sphinx_runpython_extension",
"sphinxcontrib.googleanalytics",
"sphinx.ext.napoleon",
]
templates_path = ["_templates"]
source_parsers = {
".md": "recommonmark.parser.CommonMarkParser",
}
source_suffix = [".rst"] # , '.md']
master_doc = "index"
language = "en"
exclude_patterns = []
pygments_style = "default"
autoclass_content = "both"
master_doc = "index"
onnx_doc_folder = os.path.join(os.path.abspath(os.path.dirname(__file__)), "operators")
pygments_style = "sphinx"
# -- Options for HTML output -------------------------------------------------
html_logo = "ONNX_Runtime_icon.png"
html_static_path = ["_static"]
html_theme = "furo"
graphviz_output_format = "svg"
html_context = {
"default_mode": "auto", # auto: the documentation theme will follow the system default that you have set (light or dark)
}
html_theme_options = {
"collapse_navigation": True,
"external_links": [
{"name": "onnxruntime", "url": "https://onnxruntime.ai/"},
{"name": "github", "url": "https://github.com/microsoft/onnxruntime"},
],
"github_url": "https://github.com/microsoft/onnxruntime",
"navbar_center": [],
"navigation_depth": 5,
"page_sidebar_items": [], # default setting is: ["page-toc", "edit-this-page", "sourcelink"],
"show_nav_level": 0,
"show_prev_next": True,
"show_toc_level": 0,
# needed for sphinx 6.0
"logo": {
"text": project,
"image_light": html_logo,
"image_dark": html_logo,
"alt_text": project,
},
}
# -- Options for Google Analytics -------------------------------------------------
googleanalytics_id = "UA-156955408-1"
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"numpy": ("https://numpy.org/doc/stable", None),
"torch": ("https://pytorch.org/docs/stable/", None),
}
# -- Options for Sphinx Gallery ----------------------------------------------
sphinx_gallery_conf = {
"examples_dirs": "examples",
"gallery_dirs": "auto_examples",
}
# -- markdown options -----------------------------------------------------------
md_image_dest = "media"
md_link_replace = {
"#onnxruntimesessionoptionsenable-profiling)": "#class-onnxruntimesessionoptions)",
}
# -- Setup actions -----------------------------------------------------------
def setup(app):
# download examples for the documentation
this = os.path.abspath(os.path.dirname(__file__))
dest = os.path.join(this, "model.onnx")
if not os.path.exists(dest):
import urllib.request
url = "https://raw.githubusercontent.com/onnx/onnx/master/onnx/backend/test/data/node/test_sigmoid/model.onnx"
urllib.request.urlretrieve(url, dest)
loc = os.path.split(dest)[-1]
if not os.path.exists(loc):
shutil.copy(dest, loc)
return app
|
