[Bf-docboard-svn] bf-manual: [8340] trunk/blender_docs/manual/conf.py: conf: regenerate/create
Tobias Heinke
noreply at blender.org
Sat Aug 21 20:38:19 CEST 2021
Revision: 8340
https://developer.blender.org/rBM8340
Author: TobiasH
Date: 2021-08-21 20:38:18 +0200 (Sat, 21 Aug 2021)
Log Message:
-----------
conf: regenerate/create
move ext options to own section according to template (not subdived)
reorder everything as in the Sphinx docs
update comments
remove html options that are commented out and never used
not del blender_version var needed later
raise sphinx requirement to 4.0
Modified Paths:
--------------
trunk/blender_docs/manual/conf.py
Modified: trunk/blender_docs/manual/conf.py
===================================================================
--- trunk/blender_docs/manual/conf.py 2021-08-20 22:18:31 UTC (rev 8339)
+++ trunk/blender_docs/manual/conf.py 2021-08-21 18:38:18 UTC (rev 8340)
@@ -1,50 +1,45 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
+# Configuration file for the Blender Manual documentation.
+# created by the Sphinx 4.1.2 quickstart utility.
#
-# Blender Manual documentation build configuration file, created by
-# sphinx-quickstart on Fri Jun 10 12:33:27 2016.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
+# 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
-import os
+sys.path.insert(0, os.path.abspath(os.path.join('..', 'exts')))
# Sphinx errors out on single threaded builds see T86621
sys.setrecursionlimit(2000)
-# -----------------------------------------------------------------------------
-# Local Vars
-#
+
+# -- Local Vars --------------------------------------------------------------
+
# Not used directly by Sphinx, only used by this file.
-#
blender_version = '3.0'
-# 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.
-sys.path.insert(0, os.path.abspath(os.path.join('..', 'exts')))
+# -- Project information -----------------------------------------------------
+project = 'Blender %s Manual' % blender_version
+copyright = ': This page is licensed under a CC-BY-SA 4.0 Int. License'
+author = 'Blender Documentation Team'
-# -----------------------------------------------------------------------------
-# General Configuration
+# The major project version, used as the replacement for |version|.
+version = blender_version
+# The full version, including alpha/beta/rc tags
+# release = " ".join((blender_version, "alpha"))
+release = blender_version
-# include at end of every file
-rst_epilog = """
-.. |BLENDER_VERSION| replace:: %s
-.. |TODO| replace:: The documentation here is incomplete, you can help by :doc:`contributing </about/index>`.
-""" % blender_version
-# If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '3.3'
+# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -66,101 +61,50 @@
extensions.append('sphinx.ext.imgconverter')
image_converter = "magick"
-peertube_instance = "https://video.blender.org/"
-intersphinx_mapping = {
- 'blender_api': (
- 'https://docs.blender.org/api/' +
- blender_version +
- '/',
- None)}
-
# Add any paths that contain templates here, relative to this directory.
templates_path = ['../resources/templates']
-# The suffix(es) of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = 'Blender %s Manual' % blender_version
-copyright = ': This page is licensed under a CC-BY-SA 4.0 Int. License'
-author = 'Blender Documentation Team'
-
-# The version info for the project you are documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = blender_version
-# The full version, including alpha/beta/rc tags.
-# release = " ".join((blender_version, "alpha"))
-release = blender_version
-del blender_version
-
-# 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 = 'en'
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
+# This pattern also affects html_static_path and html_extra_path.
# exclude_patterns = ['_build']
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-#default_role = None
+# A string of reStructuredText that will be included at the end of every
+# source file that is read. This is a possible place to add substitutions
+# that should be available in every file.
+rst_epilog = """
+.. |BLENDER_VERSION| replace:: %s
+.. |TODO| replace:: The documentation here is incomplete, you can help by :doc:`contributing </about/index>`.
+""" % blender_version
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# Quit warnings about missing download file
+# suppress_warnings = ['download.not_readable']
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
+# If set to a major.minor version string like '1.1', Sphinx will compare it
+# with its version and refuse to build if it is too old.
+needs_sphinx = '4.0'
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
+# The default language to highlight source code in.
+highlight_language = 'python3'
-# The name of the Pygments (syntax highlighting) style to use.
+# The style name to use for Pygments highlighting of source code.
pygments_style = 'default'
-# By default, highlight as Python 3.
-highlight_language = 'python3'
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# -- Options for Internationalization ----------------------------------------
-# If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# The code for the language the docs are written in.
+# Any text automatically generated by Sphinx will be in that language.
+language = 'en'
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-# if not release.endswith("release"):
-todo_include_todos = True
-
-# todo_link_only = True
-
-# translations
+# Directories in which to search for additional message catalogs,
+# relative to the source directory.
locale_dirs = ['../locale/']
gettext_compact = "blender_manual"
-# Quit warnings about missing download file
-# suppress_warnings = ['download.not_readable']
-# -- Options for HTML output ---------------------------------------------
+# -- 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 = "default"
@@ -171,13 +115,13 @@
except ModuleNotFoundError:
pass
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
+# A dictionary of options that influence the look and feel of
+# the selected theme. These are theme-specific.
html_theme_options = {}
-# Add any paths that contain custom themes here, relative to this directory.
+# A list of paths that contain custom themes, either as subdirectories
+# or as zip files. Relative paths are taken as relative to
+# the configuration directory.
html_theme_path = []
if html_theme == "sphinx_rtd_theme":
@@ -191,108 +135,202 @@
extensions.append('sphinx_rtd_theme')
-
-# The name for this set of Sphinx documents.
-# "<project> v<release> documentation" by default.
+# The “title” for HTML documentation generated with Sphinx’s own templates.
+# This is appended to the <title> tag of individual pages, and
+# used in the navigation bar as the “topmost” element.
html_title = "Blender Manual"
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
# The base URL which points to the root of the HTML documentation.
-# It is used to indicate the location of document using The Canonical Link
-# Relation.
+# It is used to indicate the location of document using
+# The Canonical Link Relation.
html_baseurl = "https://docs.blender.org/manual/en/latest/"
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
+# If given, this must be the name of an image file
+# (path relative to the configuration directory) that is the logo of the docs,
+# or URL that points an image file for the logo.
#
# Socket logo from: https://www.blender.org/about/logo
html_logo = "../resources/theme/blender-logo.svg"
-# The name of an image file (relative to this directory) to use as a favicon of
-# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
+# If given, this must be the name of an image file
+# (path relative to the configuration directory) that is the favicon of
+# the docs, or URL that points an image file for the favicon.
html_favicon = "../resources/theme/favicon.ico"
-# 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 = ["../resources/theme"]
-
if html_theme == "sphinx_rtd_theme":
html_css_files = ["css/theme_overrides.css",
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-docboard-svn
mailing list