Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAaron Carlisle <carlisle.b3d@gmail.com>2016-10-23 12:14:48 +0300
committerBastien Montagne <montagne29@wanadoo.fr>2016-10-23 12:15:52 +0300
commit672e906d49e6edee056bc1df7c413fb98f04f24a (patch)
tree50c2d87d490cf0d58d90add4ed30af719cda3efb /doc/python_api/sphinx_doc_gen.py
parent8905c5c87495ad8fd876de83a968d79ac54f0e17 (diff)
Add a built-in sphinx extension to allow cross-linking to the blender manual.
This works by downloading the objects.inv file (https://www.blender.org/manual/objects.inv) and using it to resolve links with blender-manual: before them.
Diffstat (limited to 'doc/python_api/sphinx_doc_gen.py')
-rw-r--r--doc/python_api/sphinx_doc_gen.py7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py
index 5034de7c02b..6c1b694333f 100644
--- a/doc/python_api/sphinx_doc_gen.py
+++ b/doc/python_api/sphinx_doc_gen.py
@@ -1632,6 +1632,13 @@ def write_sphinx_conf_py(basepath):
file = open(filepath, "w", encoding="utf-8")
fw = file.write
+ fw("import sys, os\n")
+ fw("\n")
+ fw("extensions = ['sphinx.ext.intersphinx']\n")
+ fw("\n")
+ fw("intersphinx_mapping = {'blender_manual': ('https://www.blender.org/manual/', None)}\n")
+ fw("\n")
+
fw("project = 'Blender'\n")
# fw("master_doc = 'index'\n")
fw("copyright = u'Blender Foundation'\n")