mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-05-14 20:48:00 +00:00
0573952499
* Minor update in the documentation * Run examples during the generation of the documentation.
103 lines
3 KiB
Python
103 lines
3 KiB
Python
# Copyright (c) Microsoft Corporation. All rights reserved.
|
|
# Licensed under the MIT License.
|
|
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# Configuration file for the Sphinx documentation builder.
|
|
|
|
import os
|
|
import sys
|
|
import shutil
|
|
# Check these extensions were installed.
|
|
import sphinx_gallery.gen_gallery
|
|
# The package should be installed in a virtual environment.
|
|
import onnxruntime
|
|
# The documentation requires two extensions available at:
|
|
# https://github.com/xadupre/sphinx-docfx-yaml
|
|
# https://github.com/xadupre/sphinx-docfx-markdown
|
|
import sphinx_modern_theme
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'ONNX Runtime'
|
|
copyright = '2018, Microsoft'
|
|
author = 'Microsoft'
|
|
version = onnxruntime.__version__
|
|
release = version
|
|
|
|
# -- 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.autodoc',
|
|
"docfx_yaml.extension",
|
|
"docfx_markdown",
|
|
"pyquickhelper.sphinxext.sphinx_runpython_extension",
|
|
]
|
|
|
|
templates_path = ['_templates']
|
|
|
|
source_parsers = {
|
|
'.md': 'recommonmark.parser.CommonMarkParser',
|
|
}
|
|
|
|
source_suffix = ['.rst', '.md']
|
|
|
|
master_doc = 'intro'
|
|
language = "en"
|
|
exclude_patterns = []
|
|
pygments_style = 'sphinx'
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
html_theme = "sphinx_modern_theme"
|
|
html_theme_path = [sphinx_modern_theme.get_html_theme_path()]
|
|
html_logo = "../MSFT-Onnx-Runtime-11282019-Logo.png"
|
|
html_static_path = ['_static']
|
|
|
|
# -- Options for intersphinx extension ---------------------------------------
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library.
|
|
intersphinx_mapping = {'https://docs.python.org/': 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):
|
|
# Placeholder to initialize the folder before
|
|
# generating the documentation.
|
|
app.add_stylesheet('_static/gallery.css')
|
|
|
|
# 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):
|
|
import shutil
|
|
shutil.copy(dest, loc)
|
|
return app
|
|
|