mirror of
https://github.com/vrm-c/UniVRM.git
synced 2026-04-02 07:45:13 -05:00
96 lines
3.0 KiB
Python
96 lines
3.0 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
# import os
|
|
# import sys
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "UniVRM Programming"
|
|
copyright = "2021, VRM Consortium"
|
|
author = "VRM Consortium"
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = ["myst_parser", "gitinclude"]
|
|
myst_enable_extensions = [
|
|
# "amsmath",
|
|
# "attrs_inline",
|
|
"colon_fence",
|
|
# "deflist",
|
|
# "dollarmath",
|
|
# "fieldlist",
|
|
# "html_admonition",
|
|
# "html_image",
|
|
# "linkify",
|
|
# "replacements",
|
|
# "smartquotes",
|
|
# "strikethrough",
|
|
# "substitution",
|
|
# "tasklist",
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ["_templates"]
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
#
|
|
# This is also used if you do content translation via gettext catalogs.
|
|
# Usually you set "language" from the command line for these cases.
|
|
language = "ja"
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = "furo"
|
|
html_sidebars = {
|
|
"**": [
|
|
"sidebar/scroll-start.html",
|
|
"language.html",
|
|
"sidebar/brand.html",
|
|
"sidebar/search.html",
|
|
"sidebar/navigation.html",
|
|
"sidebar/ethical-ads.html",
|
|
"sidebar/scroll-end.html",
|
|
],
|
|
}
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ["_static"]
|
|
|
|
locale_dirs = ["locale/"]
|
|
gettext_compact = False
|
|
|
|
github_url = "https://github.com/vrm-c/UniVRM"
|
|
|
|
html_context = {
|
|
"language": language,
|
|
"display_github": True,
|
|
"github_user": "vrm-c",
|
|
"github_repo": "UniVRM",
|
|
"github_version": "master/docs/",
|
|
}
|