# # SPDX-FileCopyrightText: Copyright (c) 1993-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved. # SPDX-License-Identifier: Apache-2.0 # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # import sys import os ROOT_DIR = os.path.join(os.path.abspath(os.path.dirname(__file__)), os.path.pardir) sys.path.insert(0, ROOT_DIR) import polygraphy extensions = [ "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.autosummary", "sphinx.ext.napoleon", "sphinx.ext.mathjax", "sphinx.ext.viewcode", "myst_parser", ] # Want to be able to generate docs with no dependencies installed autodoc_mock_imports = [ "tensorrt", "onnx", "numpy", "tensorflow", "onnx_graphsurgeon", "onnxruntime", "tf2onnx", ] autodoc_default_options = { "members": True, "show-inheritance": True, "exclude-members": "activate_impl, deactivate_impl, get_input_metadata_impl, BaseNetworkFromOnnx, Encoder, Decoder, add_json_methods, constantmethod", "special-members": "__call__, __getitem__, __bool__, __enter__, __exit__", } autodoc_member_order = "bysource" autodoc_inherit_docstrings = True add_module_names = False autosummary_generate = True source_suffix = [".rst"] # The master toctree document. master_doc = "index" # General information about the project. project = "Polygraphy" copyright = "2024 NVIDIA Corporation" author = "NVIDIA" version = polygraphy.__version__ # The full version, including alpha/beta/rc tags. release = version # Style pygments_style = "colorful" html_theme = "furo" html_title = f"{project}
{version}" # Use the TRT theme and NVIDIA logo html_static_path = ["_static"] # Hide source link html_show_sourcelink = False # Output file base name for HTML help builder. htmlhelp_basename = "PolygraphyDoc" # Template files to extend default Sphinx templates. # See https://www.sphinx-doc.org/en/master/templating.html for details. templates_path = ["_templates"] # For constructor arguments to show up in Sphinx generated doc autoclass_content = "both" html_theme_options = { "light_logo": os.path.join("img", "nvlogo_black.png"), "dark_logo": os.path.join("img", "nvlogo_white.png"), "light_css_variables": { "color-api-pre-name": "#4e9a06", "color-api-name": "#4e9a06", "color-api-background": "#e8e8e8", }, "dark_css_variables": { "color-api-background": "#303030", }, "footer_icons": [ { "name": "GitHub", "url": "https://github.com/NVIDIA/TensorRT", "html": """ """, "class": "", }, ], } # Allows us to override the default page width in the Sphinx theme. def setup(app): app.add_css_file("style.css") LATEX_BUILDER = "sphinx.builders.latex" if LATEX_BUILDER in app.config.extensions: app.config.extensions.remove(LATEX_BUILDER)