117 lines
3.7 KiB
Python
117 lines
3.7 KiB
Python
|
# SPDX-FileCopyrightText: 2024 Blender Authors
|
||
|
|
#
|
||
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
||
|
|
|
||
|
|
from string import Template
|
||
|
|
import time
|
||
|
|
|
||
|
|
|
||
|
|
# These are substituted when this file is copied to the build directory.
|
||
|
|
BLENDER_VERSION_STRING = "${BLENDER_VERSION_STRING}"
|
||
|
|
BLENDER_VERSION_DOTS = "${BLENDER_VERSION_DOTS}"
|
||
|
|
BLENDER_REVISION = "${BLENDER_REVISION}"
|
||
|
|
BLENDER_REVISION_TIMESTAMP = "${BLENDER_REVISION_TIMESTAMP}"
|
||
|
|
|
||
|
|
if BLENDER_REVISION != "Unknown":
|
||
|
|
# SHA1 Git hash
|
||
|
|
BLENDER_VERSION_HASH = BLENDER_REVISION
|
||
|
|
BLENDER_VERSION_HASH_HTML_LINK = "<a href=https://projects.blender.org/blender/blender/commit/%s>%s</a>" % (
|
||
|
|
BLENDER_VERSION_HASH, BLENDER_VERSION_HASH)
|
||
|
|
BLENDER_VERSION_DATE = time.strftime("%d/%m/%Y", time.localtime(BLENDER_REVISION_TIMESTAMP))
|
||
|
|
else:
|
||
|
|
# Fallback: Should not be used
|
||
|
|
BLENDER_VERSION_HASH = "Hash Unknown"
|
||
|
|
BLENDER_VERSION_HASH_HTML_LINK = BLENDER_VERSION_HASH
|
||
|
|
BLENDER_VERSION_DATE = time.strftime("%Y-%m-%d")
|
||
|
|
|
||
|
|
extensions = ['sphinx.ext.intersphinx']
|
||
|
|
intersphinx_mapping = {'blender_manual': ("https://docs.blender.org/manual/en/dev/", None)}
|
||
|
|
project = "Blender %s Python API" % BLENDER_VERSION_STRING
|
||
|
|
root_doc = "index"
|
||
|
|
copyright = "Blender Authors"
|
||
|
|
version = BLENDER_VERSION_DOTS
|
||
|
|
release = BLENDER_VERSION_DOTS
|
||
|
|
|
||
|
|
# Set this as the default is a super-set of Python3.
|
||
|
|
highlight_language = 'python3'
|
||
|
|
# No need to detect encoding.
|
||
|
|
highlight_options = {'default': {'encoding': 'utf-8'}}
|
||
|
|
|
||
|
|
# Quiet file not in table-of-contents warnings.
|
||
|
|
exclude_patterns = [
|
||
|
|
"include__bmesh.rst",
|
||
|
|
]
|
||
|
|
|
||
|
|
html_title = "Blender Python API"
|
||
|
|
|
||
|
|
# The fallback to a built-in theme when furo is not found.
|
||
|
|
html_theme = 'default'
|
||
|
|
|
||
|
|
try:
|
||
|
|
import furo
|
||
|
|
html_theme = "furo"
|
||
|
|
del furo
|
||
|
|
except ModuleNotFoundError:
|
||
|
|
pass
|
||
|
|
|
||
|
|
if html_theme == "furo":
|
||
|
|
html_theme_options = {
|
||
|
|
"light_css_variables": {
|
||
|
|
"color-brand-primary": "#265787",
|
||
|
|
"color-brand-content": "#265787",
|
||
|
|
},
|
||
|
|
}
|
||
|
|
|
||
|
|
html_sidebars = {
|
||
|
|
"**": [
|
||
|
|
"sidebar/brand.html",
|
||
|
|
"sidebar/search.html",
|
||
|
|
"sidebar/scroll-start.html",
|
||
|
|
"sidebar/navigation.html",
|
||
|
|
"sidebar/scroll-end.html",
|
||
|
|
"sidebar/variant-selector.html",
|
||
|
|
]
|
||
|
|
}
|
||
|
|
|
||
|
|
# not helpful since the source is generated, adds to upload size.
|
||
|
|
html_copy_source = False
|
||
|
|
html_show_sphinx = False
|
||
|
|
html_baseurl = "https://docs.blender.org/api/current/"
|
||
|
|
html_use_opensearch = "https://docs.blender.org/api/current"
|
||
|
|
html_show_search_summary = True
|
||
|
|
html_split_index = True
|
||
|
|
html_static_path = ["static"]
|
||
|
|
templates_path = ["templates"]
|
||
|
|
html_context = {"commit": "%s - %s" % (BLENDER_VERSION_HASH_HTML_LINK, BLENDER_VERSION_DATE)}
|
||
|
|
html_extra_path = ["static"]
|
||
|
|
html_favicon = "static/favicon.ico"
|
||
|
|
html_logo = "static/blender_logo.svg"
|
||
|
|
# Disable default `last_updated` value, since this is the date of doc generation, not the one of the source commit.
|
||
|
|
html_last_updated_fmt = None
|
||
|
|
if html_theme == 'furo':
|
||
|
|
html_css_files = ["css/theme_overrides.css", "css/version_switch.css"]
|
||
|
|
html_js_files = ["js/version_switch.js"]
|
||
|
|
|
||
|
|
# needed for latex, pdf gen
|
||
|
|
latex_elements = {
|
||
|
|
'papersize': 'a4paper',
|
||
|
|
}
|
||
|
|
|
||
|
|
latex_documents = [("contents", "contents.tex", "Blender Index", "Blender Foundation", "manual"), ]
|
||
|
|
|
||
|
|
# Workaround for useless links leading to compile errors
|
||
|
|
# See https://github.com/sphinx-doc/sphinx/issues/3866
|
||
|
|
from sphinx.domains.python import PythonDomain
|
||
|
|
|
||
|
|
|
||
|
|
class PatchedPythonDomain(PythonDomain):
|
||
|
|
def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
|
||
|
|
if 'refspecific' in node:
|
||
|
|
del node['refspecific']
|
||
|
|
return super(PatchedPythonDomain, self).resolve_xref(
|
||
|
|
env, fromdocname, builder, typ, target, node, contnode)
|
||
|
|
|
||
|
|
|
||
|
|
def setup(app):
|
||
|
|
app.add_domain(PatchedPythonDomain, override=True)
|