mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
90ffb6a6fa
Though it covers an interesting topic in a way that can be beneficial to many Godot users, after discussion with doc team members and reduz we feel that its current scope is too out of phase with the target readership of the Godot docs. This tutorial would work better hosted out of the Godot docs, and referenced with a `.. seealso::` link for those who want to dig further into the math meat. Thanks a lot to tagcup for this contribution though (as well as the many contributions to the engine's math and rendering), and sorry for not better describing what kind of "advanced" math tutorial would be fitting for the Godot docs. Sphinx: Also reverted from mathjax to imgmath, as the former implied running JS code on every single page (regardless of their use of LaTeX formulas to renderer), so for now imgmath is simpler and good enough.
112 lines
3.5 KiB
Python
112 lines
3.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Godot Engine documentation build configuration file
|
|
|
|
import sys
|
|
import os
|
|
|
|
# -- General configuration ------------------------------------------------
|
|
|
|
needs_sphinx = '1.3'
|
|
|
|
# Sphinx extension module names and templates location
|
|
sys.path.append(os.path.abspath('extensions'))
|
|
extensions = ['gdscript', 'sphinx_tabs.tabs', 'sphinx.ext.imgmath']
|
|
templates_path = ['_templates']
|
|
|
|
# You can specify multiple suffix as a list of string: ['.rst', '.md']
|
|
source_suffix = '.rst'
|
|
source_encoding = 'utf-8-sig'
|
|
|
|
# The master toctree document
|
|
master_doc = 'index'
|
|
|
|
# General information about the project
|
|
project = 'Godot Engine'
|
|
copyright = '2014-2018, Juan Linietsky, Ariel Manzur and the Godot community (CC-BY 3.0)'
|
|
author = 'Juan Linietsky, Ariel Manzur and the Godot community'
|
|
|
|
# Version info for the project, acts as replacement for |version| and |release|
|
|
# The short X.Y version
|
|
version = 'latest'
|
|
# The full version, including alpha/beta/rc tags
|
|
release = 'latest'
|
|
|
|
language = 'en'
|
|
|
|
exclude_patterns = ['_build']
|
|
|
|
from gdscript import GDScriptLexer
|
|
from sphinx.highlighting import lexers
|
|
lexers['gdscript'] = GDScriptLexer()
|
|
|
|
# Pygments (syntax highlighting) style to use
|
|
pygments_style = 'sphinx'
|
|
highlight_language = 'gdscript'
|
|
|
|
# -- Options for HTML output ----------------------------------------------
|
|
|
|
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
|
|
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
|
|
|
import sphinx_rtd_theme
|
|
html_theme = 'sphinx_rtd_theme'
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
if on_rtd:
|
|
using_rtd_theme = True
|
|
|
|
# Theme options
|
|
html_theme_options = {
|
|
# 'typekit_id': 'hiw1hhg',
|
|
# 'analytics_id': '',
|
|
# 'sticky_navigation': True # Set to False to disable the sticky nav while scrolling.
|
|
'logo_only': True, # if we have a html_logo below, this shows /only/ the logo with no title text
|
|
'collapse_navigation': False, # Collapse navigation (False makes it tree-like)
|
|
# 'display_version': True, # Display the docs version
|
|
# 'navigation_depth': 4, # Depth of the headers shown in the navigation bar
|
|
}
|
|
|
|
# VCS options: https://docs.readthedocs.io/en/latest/vcs.html#github
|
|
html_context = {
|
|
"display_github": True, # Integrate GitHub
|
|
"github_user": "godotengine", # Username
|
|
"github_repo": "godot-docs", # Repo name
|
|
"github_version": "master", # Version
|
|
"conf_py_path": "/", # Path in the checkout to the docs root
|
|
}
|
|
|
|
html_logo = 'img/docs_logo.png'
|
|
|
|
# Output file base name for HTML help builder
|
|
htmlhelp_basename = 'GodotEnginedoc'
|
|
|
|
# -- Options for reStructuredText parser ----------------------------------
|
|
|
|
# Enable directives that insert the contents of external files
|
|
file_insertion_enabled = False
|
|
|
|
# -- Options for LaTeX output ---------------------------------------------
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title,
|
|
# author, documentclass [howto, manual, or own class]).
|
|
latex_documents = [
|
|
(master_doc, 'GodotEngine.tex', 'Godot Engine Documentation',
|
|
'Juan Linietsky, Ariel Manzur and the Godot community', 'manual'),
|
|
]
|
|
|
|
# -- Options for linkcheck builder ----------------------------------------
|
|
|
|
# disable checking urls with about.html#this_part_of_page anchors
|
|
linkcheck_anchors = False
|
|
|
|
linkcheck_timeout = 10
|
|
|
|
# -- I18n settings --------------------------------------------------------
|
|
|
|
locale_dirs = ['../sphinx/po/']
|
|
gettext_compact = False
|
|
# Exclude class reference when marked with tag i18n.
|
|
if tags.has('i18n'):
|
|
exclude_patterns = ['classes']
|