Context: add pose_object
[blender.git] / doc / python_api / sphinx_doc_gen.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20
21 SCRIPT_HELP_MSG = """
22
23 API dump in RST files
24 ---------------------
25   Run this script from Blender's root path once you have compiled Blender
26
27     blender --background --factory-startup -noaudio --python doc/python_api/sphinx_doc_gen.py
28
29   This will generate python files in doc/python_api/sphinx-in/
30   providing ./blender is or links to the blender executable
31
32   To choose sphinx-in directory:
33     blender --background --factory-startup --python doc/python_api/sphinx_doc_gen.py -- --output ../python_api
34
35   For quick builds:
36     blender --background --factory-startup --python doc/python_api/sphinx_doc_gen.py -- --partial bmesh.*
37
38
39 Sphinx: HTML generation
40 -----------------------
41   After you have built doc/python_api/sphinx-in (see above),
42   generate html docs by running:
43
44     cd doc/python_api
45     sphinx-build sphinx-in sphinx-out
46
47
48 Sphinx: PDF generation
49 ----------------------
50   After you have built doc/python_api/sphinx-in (see above),
51   generate the pdf doc by running:
52
53     sphinx-build -b latex doc/python_api/sphinx-in doc/python_api/sphinx-out
54     cd doc/python_api/sphinx-out
55     make
56
57 """
58
59 try:
60     import bpy  # Blender module
61 except ImportError:
62     print("\nERROR: this script must run from inside Blender")
63     print(SCRIPT_HELP_MSG)
64     import sys
65     sys.exit()
66
67 import rna_info  # Blender module
68
69
70 def rna_info_BuildRNAInfo_cache():
71     if rna_info_BuildRNAInfo_cache.ret is None:
72         rna_info_BuildRNAInfo_cache.ret = rna_info.BuildRNAInfo()
73     return rna_info_BuildRNAInfo_cache.ret
74
75
76 rna_info_BuildRNAInfo_cache.ret = None
77 # --- end rna_info cache
78
79 # import rpdb2; rpdb2.start_embedded_debugger('test')
80 import os
81 import sys
82 import inspect
83 import shutil
84 import logging
85
86 from platform import platform
87 PLATFORM = platform().split('-')[0].lower()  # 'linux', 'darwin', 'windows'
88
89 SCRIPT_DIR = os.path.abspath(os.path.dirname(__file__))
90
91
92 def handle_args():
93     '''
94     Parse the args passed to Blender after "--", ignored by Blender
95     '''
96     import argparse
97
98     # When --help is given, print the usage text
99     parser = argparse.ArgumentParser(
100         formatter_class=argparse.RawTextHelpFormatter,
101         usage=SCRIPT_HELP_MSG
102     )
103
104     # optional arguments
105     parser.add_argument("-p", "--partial",
106                         dest="partial",
107                         type=str,
108                         default="",
109                         help="Use a wildcard to only build specific module(s)\n"
110                              "Example: --partial bmesh*\n",
111                         required=False)
112
113     parser.add_argument("-f", "--fullrebuild",
114                         dest="full_rebuild",
115                         default=False,
116                         action='store_true',
117                         help="Rewrite all rst files in sphinx-in/ "
118                              "(default=False)",
119                         required=False)
120
121     parser.add_argument("-b", "--bpy",
122                         dest="bpy",
123                         default=False,
124                         action='store_true',
125                         help="Write the rst file of the bpy module "
126                              "(default=False)",
127                         required=False)
128
129     parser.add_argument("-o", "--output",
130                         dest="output_dir",
131                         type=str,
132                         default=SCRIPT_DIR,
133                         help="Path of the API docs (default=<script dir>)",
134                         required=False)
135
136     parser.add_argument("-B", "--sphinx-build",
137                         dest="sphinx_build",
138                         default=False,
139                         action='store_true',
140                         help="Build the html docs by running:\n"
141                              "sphinx-build SPHINX_IN SPHINX_OUT\n"
142                              "(default=False; does not depend on -P)",
143                         required=False)
144
145     parser.add_argument("-P", "--sphinx-build-pdf",
146                         dest="sphinx_build_pdf",
147                         default=False,
148                         action='store_true',
149                         help="Build the pdf by running:\n"
150                              "sphinx-build -b latex SPHINX_IN SPHINX_OUT_PDF\n"
151                              "(default=False; does not depend on -B)",
152                         required=False)
153
154     parser.add_argument("-R", "--pack-reference",
155                         dest="pack_reference",
156                         default=False,
157                         action='store_true',
158                         help="Pack all necessary files in the deployed dir.\n"
159                              "(default=False; use with -B and -P)",
160                         required=False)
161
162     parser.add_argument("-l", "--log",
163                         dest="log",
164                         default=False,
165                         action='store_true',
166                         help="Log the output of the api dump and sphinx|latex "
167                              "warnings and errors (default=False).\n"
168                              "If given, save logs in:\n"
169                              "* OUTPUT_DIR/.bpy.log\n"
170                              "* OUTPUT_DIR/.sphinx-build.log\n"
171                              "* OUTPUT_DIR/.sphinx-build_pdf.log\n"
172                              "* OUTPUT_DIR/.latex_make.log",
173                         required=False)
174
175     # parse only the args passed after '--'
176     argv = []
177     if "--" in sys.argv:
178         argv = sys.argv[sys.argv.index("--") + 1:]  # get all args after "--"
179
180     return parser.parse_args(argv)
181
182
183 ARGS = handle_args()
184
185 # ----------------------------------BPY-----------------------------------------
186
187 BPY_LOGGER = logging.getLogger('bpy')
188 BPY_LOGGER.setLevel(logging.DEBUG)
189
190 """
191 # for quick rebuilds
192 rm -rf /b/doc/python_api/sphinx-* && \
193 ./blender -b -noaudio --factory-startup -P doc/python_api/sphinx_doc_gen.py && \
194 sphinx-build doc/python_api/sphinx-in doc/python_api/sphinx-out
195
196 or
197
198 ./blender -b -noaudio --factory-startup -P doc/python_api/sphinx_doc_gen.py -- -f -B
199 """
200
201 # Switch for quick testing so doc-builds don't take so long
202 if not ARGS.partial:
203     # full build
204     FILTER_BPY_OPS = None
205     FILTER_BPY_TYPES = None
206     EXCLUDE_INFO_DOCS = False
207     EXCLUDE_MODULES = []
208
209 else:
210     # can manually edit this too:
211     # FILTER_BPY_OPS = ("import.scene", )  # allow
212     # FILTER_BPY_TYPES = ("bpy_struct", "Operator", "ID")  # allow
213     EXCLUDE_INFO_DOCS = True
214     EXCLUDE_MODULES = [
215         "aud",
216         "bgl",
217         "blf",
218         "bmesh",
219         "bmesh.ops",
220         "bmesh.types",
221         "bmesh.utils",
222         "bmesh.geometry",
223         "bpy.app",
224         "bpy.app.handlers",
225         "bpy.app.timers",
226         "bpy.app.translations",
227         "bpy.context",
228         "bpy.data",
229         "bpy.ops",  # supports filtering
230         "bpy.path",
231         "bpy.props",
232         "bpy.types",  # supports filtering
233         "bpy.utils",
234         "bpy.utils.previews",
235         "bpy_extras",
236         "gpu",
237         "gpu.types",
238         "gpu.matrix",
239         "gpu.select",
240         "gpu_extras",
241         "idprop.types",
242         "mathutils",
243         "mathutils.bvhtree",
244         "mathutils.geometry",
245         "mathutils.interpolate",
246         "mathutils.kdtree",
247         "mathutils.noise",
248         "freestyle",
249         "freestyle.chainingiterators",
250         "freestyle.functions",
251         "freestyle.predicates",
252         "freestyle.shaders",
253         "freestyle.types",
254         "freestyle.utils",
255     ]
256
257     # ------
258     # Filter
259     #
260     # TODO, support bpy.ops and bpy.types filtering
261     import fnmatch
262     m = None
263     EXCLUDE_MODULES = [m for m in EXCLUDE_MODULES if not fnmatch.fnmatchcase(m, ARGS.partial)]
264
265     # special support for bpy.types.XXX
266     FILTER_BPY_OPS = tuple([m[8:] for m in ARGS.partial.split(":") if m.startswith("bpy.ops.")])
267     if FILTER_BPY_OPS:
268         EXCLUDE_MODULES.remove("bpy.ops")
269
270     FILTER_BPY_TYPES = tuple([m[10:] for m in ARGS.partial.split(":") if m.startswith("bpy.types.")])
271     if FILTER_BPY_TYPES:
272         EXCLUDE_MODULES.remove("bpy.types")
273
274     print(FILTER_BPY_TYPES)
275
276     EXCLUDE_INFO_DOCS = (not fnmatch.fnmatchcase("info", ARGS.partial))
277
278     del m
279     del fnmatch
280
281     BPY_LOGGER.debug(
282         "Partial Doc Build, Skipping: %s\n" %
283         "\n                             ".join(sorted(EXCLUDE_MODULES)))
284
285     #
286     # done filtering
287     # --------------
288
289 try:
290     __import__("aud")
291 except ImportError:
292     BPY_LOGGER.debug("Warning: Built without 'aud' module, docs incomplete...")
293     EXCLUDE_MODULES.append("aud")
294
295 try:
296     __import__("freestyle")
297 except ImportError:
298     BPY_LOGGER.debug("Warning: Built without 'freestyle' module, docs incomplete...")
299     EXCLUDE_MODULES.extend([
300         "freestyle",
301         "freestyle.chainingiterators",
302         "freestyle.functions",
303         "freestyle.predicates",
304         "freestyle.shaders",
305         "freestyle.types",
306         "freestyle.utils",
307     ])
308
309 # Source files we use, and need to copy to the OUTPUT_DIR
310 # to have working out-of-source builds.
311 # Note that ".." is replaced by "__" in the RST files,
312 # to avoid having to match Blender's source tree.
313 EXTRA_SOURCE_FILES = (
314     "../../../release/scripts/templates_py/bmesh_simple.py",
315     "../../../release/scripts/templates_py/gizmo_operator.py",
316     "../../../release/scripts/templates_py/gizmo_operator_target.py",
317     "../../../release/scripts/templates_py/gizmo_simple.py",
318     "../../../release/scripts/templates_py/operator_simple.py",
319     "../../../release/scripts/templates_py/ui_panel_simple.py",
320     "../../../release/scripts/templates_py/ui_previews_custom_icon.py",
321     "../examples/bmesh.ops.1.py",
322     "../examples/bpy.app.translations.py",
323     "../static/favicon.ico",
324     "../static/blender_logo.svg",
325 )
326
327
328 # examples
329 EXAMPLES_DIR = os.path.abspath(os.path.join(SCRIPT_DIR, "examples"))
330 EXAMPLE_SET = set()
331 for f in os.listdir(EXAMPLES_DIR):
332     if f.endswith(".py"):
333         EXAMPLE_SET.add(os.path.splitext(f)[0])
334 EXAMPLE_SET_USED = set()
335
336 # rst files dir
337 RST_DIR = os.path.abspath(os.path.join(SCRIPT_DIR, "rst"))
338
339 # extra info, not api reference docs
340 # stored in ./rst/info_*
341 INFO_DOCS = (
342     ("info_quickstart.rst",
343      "Quickstart: new to Blender or scripting and want to get your feet wet?"),
344     ("info_overview.rst",
345      "API Overview: a more complete explanation of Python integration"),
346     ("info_api_reference.rst",
347      "API Reference Usage: examples of how to use the API reference docs"),
348     ("info_best_practice.rst",
349      "Best Practice: Conventions to follow for writing good scripts"),
350     ("info_tips_and_tricks.rst",
351      "Tips and Tricks: Hints to help you while writing scripts for Blender"),
352     ("info_gotcha.rst",
353      "Gotcha's: some of the problems you may come up against when writing scripts"),
354     ("change_log.rst", "List of changes since last Blender release"),
355 )
356
357 # only support for properties atm.
358 RNA_BLACKLIST = {
359     # XXX messes up PDF!, really a bug but for now just workaround.
360     "PreferencesSystem": {"language", }
361 }
362
363 MODULE_GROUPING = {
364     "bmesh.types": (
365         ("Base Mesh Type", '-'),
366         "BMesh",
367         ("Mesh Elements", '-'),
368         "BMVert",
369         "BMEdge",
370         "BMFace",
371         "BMLoop",
372         ("Sequence Accessors", '-'),
373         "BMElemSeq",
374         "BMVertSeq",
375         "BMEdgeSeq",
376         "BMFaceSeq",
377         "BMLoopSeq",
378         "BMIter",
379         ("Selection History", '-'),
380         "BMEditSelSeq",
381         "BMEditSelIter",
382         ("Custom-Data Layer Access", '-'),
383         "BMLayerAccessVert",
384         "BMLayerAccessEdge",
385         "BMLayerAccessFace",
386         "BMLayerAccessLoop",
387         "BMLayerCollection",
388         "BMLayerItem",
389         ("Custom-Data Layer Types", '-'),
390         "BMLoopUV",
391         "BMDeformVert"
392     )
393 }
394
395 # --------------------configure compile time options----------------------------
396
397 # -------------------------------BLENDER----------------------------------------
398
399 blender_version_strings = [str(v) for v in bpy.app.version]
400 is_release = bpy.app.version_cycle in {"rc", "release"}
401
402 # converting bytes to strings, due to T30154
403 BLENDER_REVISION = str(bpy.app.build_hash, 'utf_8')
404 BLENDER_DATE = str(bpy.app.build_date, 'utf_8')
405
406 if is_release:
407     # '2.62a'
408     BLENDER_VERSION_DOTS = ".".join(blender_version_strings[:2]) + bpy.app.version_char
409 else:
410     # '2.62.1'
411     BLENDER_VERSION_DOTS = ".".join(blender_version_strings)
412 if BLENDER_REVISION != "Unknown":
413     # '2.62a SHA1' (release) or '2.62.1 SHA1' (non-release)
414     BLENDER_VERSION_DOTS += " " + BLENDER_REVISION
415
416 if is_release:
417     # '2_62a_release'
418     BLENDER_VERSION_PATH = "%s%s_release" % ("_".join(blender_version_strings[:2]), bpy.app.version_char)
419 else:
420     # '2_62_1'
421     BLENDER_VERSION_PATH = "_".join(blender_version_strings)
422
423 # --------------------------DOWNLOADABLE FILES----------------------------------
424
425 REFERENCE_NAME = "blender_python_reference_%s" % BLENDER_VERSION_PATH
426 REFERENCE_PATH = os.path.join(ARGS.output_dir, REFERENCE_NAME)
427 BLENDER_PDF_FILENAME = "%s.pdf" % REFERENCE_NAME
428 BLENDER_ZIP_FILENAME = "%s.zip" % REFERENCE_NAME
429
430 # -------------------------------SPHINX-----------------------------------------
431
432 SPHINX_IN = os.path.join(ARGS.output_dir, "sphinx-in")
433 SPHINX_IN_TMP = SPHINX_IN + "-tmp"
434 SPHINX_OUT = os.path.join(ARGS.output_dir, "sphinx-out")
435
436 # html build
437 if ARGS.sphinx_build:
438     SPHINX_BUILD = ["sphinx-build", SPHINX_IN, SPHINX_OUT]
439
440     if ARGS.log:
441         SPHINX_BUILD_LOG = os.path.join(ARGS.output_dir, ".sphinx-build.log")
442         SPHINX_BUILD = ["sphinx-build",
443                         "-w", SPHINX_BUILD_LOG,
444                         SPHINX_IN, SPHINX_OUT]
445
446 # pdf build
447 if ARGS.sphinx_build_pdf:
448     SPHINX_OUT_PDF = os.path.join(ARGS.output_dir, "sphinx-out_pdf")
449     SPHINX_BUILD_PDF = ["sphinx-build",
450                         "-b", "latex",
451                         SPHINX_IN, SPHINX_OUT_PDF]
452     SPHINX_MAKE_PDF = ["make", "-C", SPHINX_OUT_PDF]
453     SPHINX_MAKE_PDF_STDOUT = None
454
455     if ARGS.log:
456         SPHINX_BUILD_PDF_LOG = os.path.join(ARGS.output_dir, ".sphinx-build_pdf.log")
457         SPHINX_BUILD_PDF = ["sphinx-build", "-b", "latex",
458                             "-w", SPHINX_BUILD_PDF_LOG,
459                             SPHINX_IN, SPHINX_OUT_PDF]
460
461         sphinx_make_pdf_log = os.path.join(ARGS.output_dir, ".latex_make.log")
462         SPHINX_MAKE_PDF_STDOUT = open(sphinx_make_pdf_log, "w", encoding="utf-8")
463
464 # --------------------------------API DUMP--------------------------------------
465
466 # lame, python won't give some access
467 ClassMethodDescriptorType = type(dict.__dict__['fromkeys'])
468 MethodDescriptorType = type(dict.get)
469 GetSetDescriptorType = type(int.real)
470 StaticMethodType = type(staticmethod(lambda: None))
471 from types import (
472     MemberDescriptorType,
473     MethodType,
474     FunctionType,
475 )
476
477 _BPY_STRUCT_FAKE = "bpy_struct"
478 _BPY_PROP_COLLECTION_FAKE = "bpy_prop_collection"
479
480 if _BPY_PROP_COLLECTION_FAKE:
481     _BPY_PROP_COLLECTION_ID = ":class:`%s`" % _BPY_PROP_COLLECTION_FAKE
482 else:
483     _BPY_PROP_COLLECTION_ID = "collection"
484
485
486 def escape_rst(text):
487     """ Escape plain text which may contain characters used by RST.
488     """
489     return text.translate(escape_rst.trans)
490
491
492 escape_rst.trans = str.maketrans({
493     "`": "\\`",
494     "|": "\\|",
495     "*": "\\*",
496     "\\": "\\\\",
497 })
498
499
500 def is_struct_seq(value):
501     return isinstance(value, tuple) and type(tuple) != tuple and hasattr(value, "n_fields")
502
503
504 def undocumented_message(module_name, type_name, identifier):
505     return "Undocumented `contribute <https://developer.blender.org/T51061>`"
506
507
508 def range_str(val):
509     '''
510     Converts values to strings for the range directive.
511     (unused function it seems)
512     '''
513     if val < -10000000:
514         return '-inf'
515     elif val > 10000000:
516         return 'inf'
517     elif type(val) == float:
518         return '%g' % val
519     else:
520         return str(val)
521
522
523 def example_extract_docstring(filepath):
524     file = open(filepath, "r", encoding="utf-8")
525     line = file.readline()
526     line_no = 0
527     text = []
528     if line.startswith('"""'):  # assume nothing here
529         line_no += 1
530     else:
531         file.close()
532         return "", 0
533
534     for line in file.readlines():
535         line_no += 1
536         if line.startswith('"""'):
537             break
538         else:
539             text.append(line.rstrip())
540
541     line_no += 1
542     file.close()
543     return "\n".join(text), line_no
544
545
546 def title_string(text, heading_char, double=False):
547     filler = len(text) * heading_char
548
549     if double:
550         return "%s\n%s\n%s\n\n" % (filler, text, filler)
551     else:
552         return "%s\n%s\n\n" % (text, filler)
553
554
555 def write_example_ref(ident, fw, example_id, ext="py"):
556     if example_id in EXAMPLE_SET:
557
558         # extract the comment
559         filepath = os.path.join("..", "examples", "%s.%s" % (example_id, ext))
560         filepath_full = os.path.join(os.path.dirname(fw.__self__.name), filepath)
561
562         text, line_no = example_extract_docstring(filepath_full)
563
564         for line in text.split("\n"):
565             fw("%s\n" % (ident + line).rstrip())
566         fw("\n")
567
568         fw("%s.. literalinclude:: %s\n" % (ident, filepath))
569         if line_no > 0:
570             fw("%s   :lines: %d-\n" % (ident, line_no))
571         fw("\n")
572         EXAMPLE_SET_USED.add(example_id)
573     else:
574         if bpy.app.debug:
575             BPY_LOGGER.debug("\tskipping example: " + example_id)
576
577     # Support for numbered files bpy.types.Operator -> bpy.types.Operator.1.py
578     i = 1
579     while True:
580         example_id_num = "%s.%d" % (example_id, i)
581         if example_id_num in EXAMPLE_SET:
582             write_example_ref(ident, fw, example_id_num, ext)
583             i += 1
584         else:
585             break
586
587
588 def write_indented_lines(ident, fn, text, strip=True):
589     '''
590     Apply same indentation to all lines in a multilines text.
591     '''
592     if text is None:
593         return
594
595     lines = text.split("\n")
596
597     # strip empty lines from the start/end
598     while lines and not lines[0].strip():
599         del lines[0]
600     while lines and not lines[-1].strip():
601         del lines[-1]
602
603     if strip:
604         # set indentation to <indent>
605         ident_strip = 1000
606         for l in lines:
607             if l.strip():
608                 ident_strip = min(ident_strip, len(l) - len(l.lstrip()))
609         for l in lines:
610             fn(ident + l[ident_strip:] + "\n")
611     else:
612         # add <indent> number of blanks to the current indentation
613         for l in lines:
614             fn(ident + l + "\n")
615
616
617 def pymethod2sphinx(ident, fw, identifier, py_func):
618     '''
619     class method to sphinx
620     '''
621     arg_str = inspect.formatargspec(*inspect.getargspec(py_func))
622     if arg_str.startswith("(self, "):
623         arg_str = "(" + arg_str[7:]
624         func_type = "method"
625     elif arg_str.startswith("(cls, "):
626         arg_str = "(" + arg_str[6:]
627         func_type = "classmethod"
628     else:
629         func_type = "staticmethod"
630
631     fw(ident + ".. %s:: %s%s\n\n" % (func_type, identifier, arg_str))
632     if py_func.__doc__:
633         write_indented_lines(ident + "   ", fw, py_func.__doc__)
634         fw("\n")
635
636
637 def pyfunc2sphinx(ident, fw, module_name, type_name, identifier, py_func, is_class=True):
638     '''
639     function or class method to sphinx
640     '''
641
642     if type(py_func) == MethodType:
643         return
644
645     arg_str = str(inspect.signature(py_func))
646
647     if not is_class:
648         func_type = "function"
649
650         # the rest are class methods
651     elif arg_str.startswith("(self, ") or arg_str == "(self)":
652         arg_str = "()" if (arg_str == "(self)") else ("(" + arg_str[7:])
653         func_type = "method"
654     elif arg_str.startswith("(cls, "):
655         arg_str = "()" if (arg_str == "(cls)") else ("(" + arg_str[6:])
656         func_type = "classmethod"
657     else:
658         func_type = "staticmethod"
659
660     doc = py_func.__doc__
661     if (not doc) or (not doc.startswith(".. %s:: " % func_type)):
662         fw(ident + ".. %s:: %s%s\n\n" % (func_type, identifier, arg_str))
663         ident_temp = ident + "   "
664     else:
665         ident_temp = ident
666
667     if doc:
668         write_indented_lines(ident_temp, fw, doc)
669         fw("\n")
670     del doc, ident_temp
671
672     if is_class:
673         write_example_ref(ident + "   ", fw, module_name + "." + type_name + "." + identifier)
674     else:
675         write_example_ref(ident + "   ", fw, module_name + "." + identifier)
676
677
678 def py_descr2sphinx(ident, fw, descr, module_name, type_name, identifier):
679     if identifier.startswith("_"):
680         return
681
682     doc = descr.__doc__
683     if not doc:
684         doc = undocumented_message(module_name, type_name, identifier)
685
686     if type(descr) == GetSetDescriptorType:
687         fw(ident + ".. attribute:: %s\n\n" % identifier)
688         write_indented_lines(ident + "   ", fw, doc, False)
689         fw("\n")
690     elif type(descr) == MemberDescriptorType:  # same as above but use 'data'
691         fw(ident + ".. data:: %s\n\n" % identifier)
692         write_indented_lines(ident + "   ", fw, doc, False)
693         fw("\n")
694     elif type(descr) in {MethodDescriptorType, ClassMethodDescriptorType}:
695         write_indented_lines(ident, fw, doc, False)
696         fw("\n")
697     else:
698         raise TypeError("type was not GetSetDescriptorType, MethodDescriptorType or ClassMethodDescriptorType")
699
700     write_example_ref(ident + "   ", fw, module_name + "." + type_name + "." + identifier)
701     fw("\n")
702
703
704 def py_c_func2sphinx(ident, fw, module_name, type_name, identifier, py_func, is_class=True):
705     '''
706     c defined function to sphinx.
707     '''
708
709     # dump the docstring, assume its formatted correctly
710     if py_func.__doc__:
711         write_indented_lines(ident, fw, py_func.__doc__, False)
712         fw("\n")
713     else:
714         fw(ident + ".. function:: %s()\n\n" % identifier)
715         fw(ident + "   " + undocumented_message(module_name, type_name, identifier))
716
717     if is_class:
718         write_example_ref(ident + "   ", fw, module_name + "." + type_name + "." + identifier)
719     else:
720         write_example_ref(ident + "   ", fw, module_name + "." + identifier)
721
722     fw("\n")
723
724
725 def pyprop2sphinx(ident, fw, identifier, py_prop):
726     '''
727     Python property to sphinx
728     '''
729     # readonly properties use "data" directive, variables use "attribute" directive
730     if py_prop.fset is None:
731         fw(ident + ".. data:: %s\n\n" % identifier)
732     else:
733         fw(ident + ".. attribute:: %s\n\n" % identifier)
734     write_indented_lines(ident + "   ", fw, py_prop.__doc__)
735     if py_prop.fset is None:
736         fw(ident + "   (readonly)\n\n")
737     else:
738         fw("\n")
739
740
741 def pymodule2sphinx(basepath, module_name, module, title):
742     import types
743     attribute_set = set()
744     filepath = os.path.join(basepath, module_name + ".rst")
745
746     module_all = getattr(module, "__all__", None)
747     module_dir = sorted(dir(module))
748
749     if module_all:
750         module_dir = module_all
751
752     # TODO - currently only used for classes
753     # grouping support
754     module_grouping = MODULE_GROUPING.get(module_name)
755
756     def module_grouping_index(name):
757         if module_grouping is not None:
758             try:
759                 return module_grouping.index(name)
760             except ValueError:
761                 pass
762         return -1
763
764     def module_grouping_heading(name):
765         if module_grouping is not None:
766             i = module_grouping_index(name) - 1
767             if i >= 0 and type(module_grouping[i]) == tuple:
768                 return module_grouping[i]
769         return None, None
770
771     def module_grouping_sort_key(name):
772         return module_grouping_index(name)
773     # done grouping support
774
775     file = open(filepath, "w", encoding="utf-8")
776
777     fw = file.write
778
779     fw(title_string("%s (%s)" % (title, module_name), "="))
780
781     fw(".. module:: %s\n\n" % module_name)
782
783     if module.__doc__:
784         # Note, may contain sphinx syntax, don't mangle!
785         fw(module.__doc__.strip())
786         fw("\n\n")
787
788     write_example_ref("", fw, module_name)
789
790     # write submodules
791     # we could also scan files but this ensures __all__ is used correctly
792     if module_all is not None:
793         submod_name = None
794         submod = None
795         submod_ls = []
796         for submod_name in module_all:
797             ns = {}
798             exec_str = "from %s import %s as submod" % (module.__name__, submod_name)
799             exec(exec_str, ns, ns)
800             submod = ns["submod"]
801             if type(submod) == types.ModuleType:
802                 submod_ls.append((submod_name, submod))
803
804         del submod_name
805         del submod
806
807         if submod_ls:
808             fw(".. toctree::\n")
809             fw("   :maxdepth: 1\n\n")
810
811             for submod_name, submod in submod_ls:
812                 submod_name_full = "%s.%s" % (module_name, submod_name)
813                 fw("   %s.rst\n\n" % submod_name_full)
814
815                 pymodule2sphinx(basepath, submod_name_full, submod, "%s submodule" % module_name)
816         del submod_ls
817     # done writing submodules!
818
819     # write members of the module
820     # only tested with PyStructs which are not exactly modules
821     for key, descr in sorted(type(module).__dict__.items()):
822         if key.startswith("__"):
823             continue
824         # naughty, we also add getset's into PyStructs, this is not typical py but also not incorrect.
825
826         # type_name is only used for examples and messages
827         # "<class 'bpy.app.handlers'>" --> bpy.app.handlers
828         type_name = str(type(module)).strip("<>").split(" ", 1)[-1][1:-1]
829         if type(descr) == types.GetSetDescriptorType:
830             py_descr2sphinx("", fw, descr, module_name, type_name, key)
831             attribute_set.add(key)
832     descr_sorted = []
833     for key, descr in sorted(type(module).__dict__.items()):
834         if key.startswith("__"):
835             continue
836
837         if type(descr) == MemberDescriptorType:
838             if descr.__doc__:
839                 value = getattr(module, key, None)
840
841                 value_type = type(value)
842                 descr_sorted.append((key, descr, value, type(value)))
843     # sort by the valye type
844     descr_sorted.sort(key=lambda descr_data: str(descr_data[3]))
845     for key, descr, value, value_type in descr_sorted:
846
847         # must be documented as a submodule
848         if is_struct_seq(value):
849             continue
850
851         type_name = value_type.__name__
852         py_descr2sphinx("", fw, descr, module_name, type_name, key)
853
854         attribute_set.add(key)
855
856     del key, descr, descr_sorted
857
858     classes = []
859     submodules = []
860
861     # use this list so we can sort by type
862     module_dir_value_type = []
863
864     for attribute in module_dir:
865         if attribute.startswith("_"):
866             continue
867
868         if attribute in attribute_set:
869             continue
870
871         if attribute.startswith("n_"):  # annoying exception, needed for bpy.app
872             continue
873
874         # workaround for bpy.app documenting .index() and .count()
875         if isinstance(module, tuple) and hasattr(tuple, attribute):
876             continue
877
878         value = getattr(module, attribute)
879
880         module_dir_value_type.append((attribute, value, type(value)))
881
882     # sort by str of each type
883     # this way lists, functions etc are grouped.
884     module_dir_value_type.sort(key=lambda triple: str(triple[2]))
885
886     for attribute, value, value_type in module_dir_value_type:
887         if value_type == FunctionType:
888             pyfunc2sphinx("", fw, module_name, None, attribute, value, is_class=False)
889         # both the same at the moment but to be future proof
890         elif value_type in {types.BuiltinMethodType, types.BuiltinFunctionType}:
891             # note: can't get args from these, so dump the string as is
892             # this means any module used like this must have fully formatted docstrings.
893             py_c_func2sphinx("", fw, module_name, None, attribute, value, is_class=False)
894         elif value_type == type:
895             classes.append((attribute, value))
896         elif issubclass(value_type, types.ModuleType):
897             submodules.append((attribute, value))
898         elif issubclass(value_type, (bool, int, float, str, tuple)):
899             # constant, not much fun we can do here except to list it.
900             # TODO, figure out some way to document these!
901             fw(".. data:: %s\n\n" % attribute)
902             write_indented_lines("   ", fw, "constant value %s" % repr(value), False)
903             fw("\n")
904         else:
905             BPY_LOGGER.debug("\tnot documenting %s.%s of %r type" % (module_name, attribute, value_type.__name__))
906             continue
907
908         attribute_set.add(attribute)
909         # TODO, more types...
910     del module_dir_value_type
911
912     # TODO, bpy_extras does this already, mathutils not.
913     '''
914     if submodules:
915         fw("\n"
916            "**********\n"
917            "Submodules\n"
918            "**********\n"
919            "\n"
920            )
921         for attribute, submod in submodules:
922             fw("* :mod:`%s.%s`\n" % (module_name, attribute))
923         fw("\n")
924     '''
925
926     if module_grouping is not None:
927         classes.sort(key=lambda pair: module_grouping_sort_key(pair[0]))
928
929     # write collected classes now
930     for (type_name, value) in classes:
931
932         if module_grouping is not None:
933             heading, heading_char = module_grouping_heading(type_name)
934             if heading:
935                 fw(title_string(heading, heading_char))
936
937         # May need to be its own function
938         if value.__doc__:
939             if value.__doc__.startswith(".. class::"):
940                 fw(value.__doc__)
941             else:
942                 fw(".. class:: %s\n\n" % type_name)
943                 write_indented_lines("   ", fw, value.__doc__, True)
944         else:
945             fw(".. class:: %s\n\n" % type_name)
946         fw("\n")
947
948         write_example_ref("   ", fw, module_name + "." + type_name)
949
950         descr_items = [(key, descr) for key, descr in sorted(value.__dict__.items()) if not key.startswith("_")]
951
952         for key, descr in descr_items:
953             if type(descr) == ClassMethodDescriptorType:
954                 py_descr2sphinx("   ", fw, descr, module_name, type_name, key)
955
956         # needed for pure Python classes
957         for key, descr in descr_items:
958             if type(descr) == FunctionType:
959                 pyfunc2sphinx("   ", fw, module_name, type_name, key, descr, is_class=True)
960
961         for key, descr in descr_items:
962             if type(descr) == MethodDescriptorType:
963                 py_descr2sphinx("   ", fw, descr, module_name, type_name, key)
964
965         for key, descr in descr_items:
966             if type(descr) == GetSetDescriptorType:
967                 py_descr2sphinx("   ", fw, descr, module_name, type_name, key)
968
969         for key, descr in descr_items:
970             if type(descr) == StaticMethodType:
971                 descr = getattr(value, key)
972                 write_indented_lines("   ", fw, descr.__doc__ or "Undocumented", False)
973                 fw("\n")
974
975         fw("\n\n")
976
977     file.close()
978
979
980 # Changes in Blender will force errors here
981 context_type_map = {
982     # context_member: (RNA type, is_collection)
983     "active_base": ("ObjectBase", False),
984     "active_bone": ("EditBone", False),
985     "active_gpencil_frame": ("GreasePencilLayer", True),
986     "active_gpencil_layer": ("GPencilLayer", True),
987     "active_node": ("Node", False),
988     "active_object": ("Object", False),
989     "active_operator": ("Operator", False),
990     "active_pose_bone": ("PoseBone", False),
991     "armature": ("Armature", False),
992     "bone": ("Bone", False),
993     "brush": ("Brush", False),
994     "camera": ("Camera", False),
995     "cloth": ("ClothModifier", False),
996     "collection": ("LayerCollection", False),
997     "collision": ("CollisionModifier", False),
998     "curve": ("Curve", False),
999     "dynamic_paint": ("DynamicPaintModifier", False),
1000     "edit_bone": ("EditBone", False),
1001     "edit_image": ("Image", False),
1002     "edit_mask": ("Mask", False),
1003     "edit_movieclip": ("MovieClip", False),
1004     "edit_object": ("Object", False),
1005     "edit_text": ("Text", False),
1006     "editable_bases": ("ObjectBase", True),
1007     "editable_bones": ("EditBone", True),
1008     "editable_gpencil_layers": ("GPencilLayer", True),
1009     "editable_gpencil_strokes": ("GPencilStroke", True),
1010     "editable_objects": ("Object", True),
1011     "fluid": ("FluidSimulationModifier", False),
1012     "gpencil_data": ("GreasePencel", False),
1013     "gpencil_data_owner": ("ID", False),
1014     "image_paint_object": ("Object", False),
1015     "lattice": ("Lattice", False),
1016     "light": ("Light", False),
1017     "lightprobe": ("LightProbe", False),
1018     "line_style": ("FreestyleLineStyle", False),
1019     "material": ("Material", False),
1020     "material_slot": ("MaterialSlot", False),
1021     "mesh": ("Mesh", False),
1022     "meta_ball": ("MetaBall", False),
1023     "object": ("Object", False),
1024     "objects_in_mode": ("Object", True),
1025     "objects_in_mode_unique_data": ("Object", True),
1026     "particle_edit_object": ("Object", False),
1027     "particle_settings": ("ParticleSettings", False),
1028     "particle_system": ("ParticleSystem", False),
1029     "particle_system_editable": ("ParticleSystem", False),
1030     "pose_bone": ("PoseBone", False),
1031     "pose_object": ("Object", False),
1032     "scene": ("Scene", False),
1033     "sculpt_object": ("Object", False),
1034     "selectable_bases": ("ObjectBase", True),
1035     "selectable_objects": ("Object", True),
1036     "selected_bases": ("ObjectBase", True),
1037     "selected_bones": ("EditBone", True),
1038     "selected_editable_bases": ("ObjectBase", True),
1039     "selected_editable_bones": ("EditBone", True),
1040     "selected_editable_fcurves": ("FCurve", True),
1041     "selected_editable_objects": ("Object", True),
1042     "selected_editable_sequences": ("Sequence", True),
1043     "selected_nodes": ("Node", True),
1044     "selected_objects": ("Object", True),
1045     "selected_pose_bones": ("PoseBone", True),
1046     "selected_pose_bones_from_active_object": ("PoseBone", True),
1047     "selected_sequences": ("Sequence", True),
1048     "sequences": ("Sequence", True),
1049     "smoke": ("SmokeModifier", False),
1050     "soft_body": ("SoftBodyModifier", False),
1051     "speaker": ("Speaker", False),
1052     "texture": ("Texture", False),
1053     "texture_slot": ("MaterialTextureSlot", False),
1054     "texture_user": ("ID", False),
1055     "texture_user_property": ("Property", False),
1056     "uv_sculpt_object": ("Object", False),
1057     "vertex_paint_object": ("Object", False),
1058     "view_layer": ("ViewLayer", False),
1059     "visible_bases": ("ObjectBase", True),
1060     "visible_bones": ("EditBone", True),
1061     "visible_gpencil_layers": ("GPencilLayer", True),
1062     "visible_objects": ("Object", True),
1063     "visible_pose_bones": ("PoseBone", True),
1064     "weight_paint_object": ("Object", False),
1065     "world": ("World", False),
1066 }
1067
1068
1069 def pycontext2sphinx(basepath):
1070     # Only use once. very irregular
1071
1072     filepath = os.path.join(basepath, "bpy.context.rst")
1073     file = open(filepath, "w", encoding="utf-8")
1074     fw = file.write
1075     fw(title_string("Context Access (bpy.context)", "="))
1076     fw(".. module:: bpy.context\n")
1077     fw("\n")
1078     fw("The context members available depend on the area of Blender which is currently being accessed.\n")
1079     fw("\n")
1080     fw("Note that all context values are readonly,\n")
1081     fw("but may be modified through the data api or by running operators\n\n")
1082
1083     def write_contex_cls():
1084
1085         fw(title_string("Global Context", "-"))
1086         fw("These properties are available in any contexts.\n\n")
1087
1088         # very silly. could make these global and only access once.
1089         # structs, funcs, ops, props = rna_info.BuildRNAInfo()
1090         structs, funcs, ops, props = rna_info_BuildRNAInfo_cache()
1091         struct = structs[("", "Context")]
1092         struct_blacklist = RNA_BLACKLIST.get(struct.identifier, ())
1093         del structs, funcs, ops, props
1094
1095         sorted_struct_properties = struct.properties[:]
1096         sorted_struct_properties.sort(key=lambda prop: prop.identifier)
1097
1098         # First write RNA
1099         for prop in sorted_struct_properties:
1100             # support blacklisting props
1101             if prop.identifier in struct_blacklist:
1102                 continue
1103
1104             type_descr = prop.get_type_description(
1105                 class_fmt=":class:`bpy.types.%s`", collection_id=_BPY_PROP_COLLECTION_ID)
1106             fw(".. data:: %s\n\n" % prop.identifier)
1107             if prop.description:
1108                 fw("   %s\n\n" % prop.description)
1109
1110             # special exception, can't use generic code here for enums
1111             if prop.type == "enum":
1112                 enum_text = pyrna_enum2sphinx(prop)
1113                 if enum_text:
1114                     write_indented_lines("   ", fw, enum_text)
1115                     fw("\n")
1116                 del enum_text
1117             # end enum exception
1118
1119             fw("   :type: %s\n\n" % type_descr)
1120
1121     write_contex_cls()
1122     del write_contex_cls
1123     # end
1124
1125     # nasty, get strings directly from Blender because there is no other way to get it
1126     import ctypes
1127
1128     context_strings = (
1129         "screen_context_dir",
1130         "view3d_context_dir",
1131         "buttons_context_dir",
1132         "image_context_dir",
1133         "node_context_dir",
1134         "text_context_dir",
1135         "clip_context_dir",
1136         "sequencer_context_dir",
1137     )
1138
1139     unique = set()
1140     blend_cdll = ctypes.CDLL("")
1141     for ctx_str in context_strings:
1142         subsection = "%s Context" % ctx_str.split("_")[0].title()
1143         fw("\n%s\n%s\n\n" % (subsection, (len(subsection) * '-')))
1144
1145         attr = ctypes.addressof(getattr(blend_cdll, ctx_str))
1146         c_char_p_p = ctypes.POINTER(ctypes.c_char_p)
1147         char_array = c_char_p_p.from_address(attr)
1148         i = 0
1149         while char_array[i] is not None:
1150             member = ctypes.string_at(char_array[i]).decode(encoding="ascii")
1151             fw(".. data:: %s\n\n" % member)
1152             member_type, is_seq = context_type_map[member]
1153             fw("   :type: %s :class:`bpy.types.%s`\n\n" % ("sequence of " if is_seq else "", member_type))
1154             unique.add(member)
1155             i += 1
1156
1157     # generate typemap...
1158     # for member in sorted(unique):
1159     #     print('        "%s": ("", False),' % member)
1160     if len(context_type_map) > len(unique):
1161         raise Exception(
1162             "Some types are not used: %s" %
1163             str([member for member in context_type_map if member not in unique]))
1164     else:
1165         pass  # will have raised an error above
1166
1167     file.close()
1168
1169
1170 def pyrna_enum2sphinx(prop, use_empty_descriptions=False):
1171     """ write a bullet point list of enum + descriptions
1172     """
1173
1174     if use_empty_descriptions:
1175         ok = True
1176     else:
1177         ok = False
1178         for identifier, name, description in prop.enum_items:
1179             if description:
1180                 ok = True
1181                 break
1182
1183     if ok:
1184         return "".join(["* ``%s`` %s.\n" %
1185                         (identifier,
1186                          ", ".join(escape_rst(val) for val in (name, description) if val),
1187                          )
1188                         for identifier, name, description in prop.enum_items
1189                         ])
1190     else:
1191         return ""
1192
1193
1194 def pyrna2sphinx(basepath):
1195     """ bpy.types and bpy.ops
1196     """
1197     # structs, funcs, ops, props = rna_info.BuildRNAInfo()
1198     structs, funcs, ops, props = rna_info_BuildRNAInfo_cache()
1199
1200     if FILTER_BPY_TYPES is not None:
1201         structs = {k: v for k, v in structs.items() if k[1] in FILTER_BPY_TYPES}
1202
1203     if FILTER_BPY_OPS is not None:
1204         ops = {k: v for k, v in ops.items() if v.module_name in FILTER_BPY_OPS}
1205
1206     def write_param(ident, fw, prop, is_return=False):
1207         if is_return:
1208             id_name = "return"
1209             id_type = "rtype"
1210             kwargs = {"as_ret": True}
1211             identifier = ""
1212         else:
1213             id_name = "arg"
1214             id_type = "type"
1215             kwargs = {"as_arg": True}
1216             identifier = " %s" % prop.identifier
1217
1218         kwargs["class_fmt"] = ":class:`%s`"
1219
1220         kwargs["collection_id"] = _BPY_PROP_COLLECTION_ID
1221
1222         type_descr = prop.get_type_description(**kwargs)
1223
1224         enum_text = pyrna_enum2sphinx(prop)
1225
1226         if prop.name or prop.description or enum_text:
1227             fw(ident + ":%s%s:\n\n" % (id_name, identifier))
1228
1229             if prop.name or prop.description:
1230                 fw(ident + "   " + ", ".join(val for val in (prop.name, prop.description) if val) + "\n\n")
1231
1232             # special exception, can't use generic code here for enums
1233             if enum_text:
1234                 write_indented_lines(ident + "   ", fw, enum_text)
1235                 fw("\n")
1236             del enum_text
1237             # end enum exception
1238
1239         fw(ident + ":%s%s: %s\n" % (id_type, identifier, type_descr))
1240
1241     def write_struct(struct):
1242         # if not struct.identifier.startswith("Sc") and not struct.identifier.startswith("I"):
1243         #     return
1244
1245         # if not struct.identifier == "Object":
1246         #     return
1247
1248         filepath = os.path.join(basepath, "bpy.types.%s.rst" % struct.identifier)
1249         file = open(filepath, "w", encoding="utf-8")
1250         fw = file.write
1251
1252         base_id = getattr(struct.base, "identifier", "")
1253         struct_id = struct.identifier
1254
1255         if _BPY_STRUCT_FAKE:
1256             if not base_id:
1257                 base_id = _BPY_STRUCT_FAKE
1258
1259         if base_id:
1260             title = "%s(%s)" % (struct_id, base_id)
1261         else:
1262             title = struct_id
1263
1264         fw(title_string(title, "="))
1265
1266         fw(".. module:: bpy.types\n\n")
1267
1268         # docs first?, ok
1269         write_example_ref("", fw, "bpy.types.%s" % struct_id)
1270
1271         base_ids = [base.identifier for base in struct.get_bases()]
1272
1273         if _BPY_STRUCT_FAKE:
1274             base_ids.append(_BPY_STRUCT_FAKE)
1275
1276         base_ids.reverse()
1277
1278         if base_ids:
1279             if len(base_ids) > 1:
1280                 fw("base classes --- ")
1281             else:
1282                 fw("base class --- ")
1283
1284             fw(", ".join((":class:`%s`" % base_id) for base_id in base_ids))
1285             fw("\n\n")
1286
1287         subclass_ids = [
1288             s.identifier for s in structs.values()
1289             if s.base is struct
1290             if not rna_info.rna_id_ignore(s.identifier)
1291         ]
1292         subclass_ids.sort()
1293         if subclass_ids:
1294             fw("subclasses --- \n" + ", ".join((":class:`%s`" % s) for s in subclass_ids) + "\n\n")
1295
1296         base_id = getattr(struct.base, "identifier", "")
1297
1298         if _BPY_STRUCT_FAKE:
1299             if not base_id:
1300                 base_id = _BPY_STRUCT_FAKE
1301
1302         if base_id:
1303             fw(".. class:: %s(%s)\n\n" % (struct_id, base_id))
1304         else:
1305             fw(".. class:: %s\n\n" % struct_id)
1306
1307         fw("   %s\n\n" % struct.description)
1308
1309         # properties sorted in alphabetical order
1310         sorted_struct_properties = struct.properties[:]
1311         sorted_struct_properties.sort(key=lambda prop: prop.identifier)
1312
1313         # support blacklisting props
1314         struct_blacklist = RNA_BLACKLIST.get(struct_id, ())
1315
1316         for prop in sorted_struct_properties:
1317
1318             # support blacklisting props
1319             if prop.identifier in struct_blacklist:
1320                 continue
1321
1322             type_descr = prop.get_type_description(class_fmt=":class:`%s`", collection_id=_BPY_PROP_COLLECTION_ID)
1323             # readonly properties use "data" directive, variables properties use "attribute" directive
1324             if 'readonly' in type_descr:
1325                 fw("   .. data:: %s\n\n" % prop.identifier)
1326             else:
1327                 fw("   .. attribute:: %s\n\n" % prop.identifier)
1328             if prop.description:
1329                 fw("      %s\n\n" % prop.description)
1330
1331             # special exception, can't use generic code here for enums
1332             if prop.type == "enum":
1333                 enum_text = pyrna_enum2sphinx(prop)
1334                 if enum_text:
1335                     write_indented_lines("      ", fw, enum_text)
1336                     fw("\n")
1337                 del enum_text
1338             # end enum exception
1339
1340             fw("      :type: %s\n\n" % type_descr)
1341
1342         # Python attributes
1343         py_properties = struct.get_py_properties()
1344         py_prop = None
1345         for identifier, py_prop in py_properties:
1346             pyprop2sphinx("   ", fw, identifier, py_prop)
1347         del py_properties, py_prop
1348
1349         for func in struct.functions:
1350             args_str = ", ".join(prop.get_arg_default(force=False) for prop in func.args)
1351
1352             fw("   .. %s:: %s(%s)\n\n" %
1353                ("classmethod" if func.is_classmethod else "method", func.identifier, args_str))
1354             fw("      %s\n\n" % func.description)
1355
1356             for prop in func.args:
1357                 write_param("      ", fw, prop)
1358
1359             if len(func.return_values) == 1:
1360                 write_param("      ", fw, func.return_values[0], is_return=True)
1361             elif func.return_values:  # multiple return values
1362                 fw("      :return (%s):\n" % ", ".join(prop.identifier for prop in func.return_values))
1363                 for prop in func.return_values:
1364                     # TODO, pyrna_enum2sphinx for multiple return values... actually don't
1365                     # think we even use this but still!!!
1366                     type_descr = prop.get_type_description(
1367                         as_ret=True, class_fmt=":class:`%s`", collection_id=_BPY_PROP_COLLECTION_ID)
1368                     descr = prop.description
1369                     if not descr:
1370                         descr = prop.name
1371                     # In rare cases descr may be empty
1372                     fw("         `%s`, %s\n\n" %
1373                        (prop.identifier,
1374                         ", ".join((val for val in (descr, type_descr) if val))))
1375
1376             write_example_ref("      ", fw, "bpy.types." + struct_id + "." + func.identifier)
1377
1378             fw("\n")
1379
1380         # Python methods
1381         py_funcs = struct.get_py_functions()
1382         py_func = None
1383
1384         for identifier, py_func in py_funcs:
1385             pyfunc2sphinx("   ", fw, "bpy.types", struct_id, identifier, py_func, is_class=True)
1386         del py_funcs, py_func
1387
1388         py_funcs = struct.get_py_c_functions()
1389         py_func = None
1390
1391         for identifier, py_func in py_funcs:
1392             py_c_func2sphinx("   ", fw, "bpy.types", struct_id, identifier, py_func, is_class=True)
1393
1394         lines = []
1395
1396         if struct.base or _BPY_STRUCT_FAKE:
1397             bases = list(reversed(struct.get_bases()))
1398
1399             # props
1400             del lines[:]
1401
1402             if _BPY_STRUCT_FAKE:
1403                 descr_items = [
1404                     (key, descr) for key, descr in sorted(bpy.types.Struct.__bases__[0].__dict__.items())
1405                     if not key.startswith("__")
1406                 ]
1407
1408             if _BPY_STRUCT_FAKE:
1409                 for key, descr in descr_items:
1410                     if type(descr) == GetSetDescriptorType:
1411                         lines.append("   * :class:`%s.%s`\n" % (_BPY_STRUCT_FAKE, key))
1412
1413             for base in bases:
1414                 for prop in base.properties:
1415                     lines.append("   * :class:`%s.%s`\n" % (base.identifier, prop.identifier))
1416
1417                 for identifier, py_prop in base.get_py_properties():
1418                     lines.append("   * :class:`%s.%s`\n" % (base.identifier, identifier))
1419
1420                 for identifier, py_prop in base.get_py_properties():
1421                     lines.append("   * :class:`%s.%s`\n" % (base.identifier, identifier))
1422
1423             if lines:
1424                 fw(".. rubric:: Inherited Properties\n\n")
1425
1426                 fw(".. hlist::\n")
1427                 fw("   :columns: 2\n\n")
1428
1429                 for line in lines:
1430                     fw(line)
1431                 fw("\n")
1432
1433             # funcs
1434             del lines[:]
1435
1436             if _BPY_STRUCT_FAKE:
1437                 for key, descr in descr_items:
1438                     if type(descr) == MethodDescriptorType:
1439                         lines.append("   * :class:`%s.%s`\n" % (_BPY_STRUCT_FAKE, key))
1440
1441             for base in bases:
1442                 for func in base.functions:
1443                     lines.append("   * :class:`%s.%s`\n" % (base.identifier, func.identifier))
1444                 for identifier, py_func in base.get_py_functions():
1445                     lines.append("   * :class:`%s.%s`\n" % (base.identifier, identifier))
1446
1447             if lines:
1448                 fw(".. rubric:: Inherited Functions\n\n")
1449
1450                 fw(".. hlist::\n")
1451                 fw("   :columns: 2\n\n")
1452
1453                 for line in lines:
1454                     fw(line)
1455                 fw("\n")
1456
1457             del lines[:]
1458
1459         if struct.references:
1460             # use this otherwise it gets in the index for a normal heading.
1461             fw(".. rubric:: References\n\n")
1462
1463             fw(".. hlist::\n")
1464             fw("   :columns: 2\n\n")
1465
1466             # context does its own thing
1467             # "active_base": ("ObjectBase", False),
1468             for ref_attr, (ref_type, ref_is_seq) in sorted(context_type_map.items()):
1469                 if ref_type == struct_id:
1470                     fw("   * :mod:`bpy.context.%s`\n" % ref_attr)
1471             del ref_attr, ref_type, ref_is_seq
1472
1473             for ref in struct.references:
1474                 ref_split = ref.split(".")
1475                 if len(ref_split) > 2:
1476                     ref = ref_split[-2] + "." + ref_split[-1]
1477                 fw("   * :class:`%s`\n" % ref)
1478             fw("\n")
1479
1480         # docs last?, disable for now
1481         # write_example_ref("", fw, "bpy.types.%s" % struct_id)
1482         file.close()
1483
1484     if "bpy.types" not in EXCLUDE_MODULES:
1485         for struct in structs.values():
1486             # TODO, rna_info should filter these out!
1487             if "_OT_" in struct.identifier:
1488                 continue
1489             write_struct(struct)
1490
1491         def fake_bpy_type(class_value, class_name, descr_str, use_subclasses=True):
1492             filepath = os.path.join(basepath, "bpy.types.%s.rst" % class_name)
1493             file = open(filepath, "w", encoding="utf-8")
1494             fw = file.write
1495
1496             fw(title_string(class_name, "="))
1497
1498             fw(".. module:: bpy.types\n")
1499             fw("\n")
1500
1501             if use_subclasses:
1502                 subclass_ids = [
1503                     s.identifier for s in structs.values()
1504                     if s.base is None
1505                     if not rna_info.rna_id_ignore(s.identifier)
1506                 ]
1507                 if subclass_ids:
1508                     fw("subclasses --- \n" + ", ".join((":class:`%s`" % s) for s in sorted(subclass_ids)) + "\n\n")
1509
1510             fw(".. class:: %s\n\n" % class_name)
1511             fw("   %s\n\n" % descr_str)
1512             fw("   .. note::\n\n")
1513             fw("      Note that bpy.types.%s is not actually available from within Blender,\n"
1514                "      it only exists for the purpose of documentation.\n\n" % class_name)
1515
1516             descr_items = [
1517                 (key, descr) for key, descr in sorted(class_value.__dict__.items())
1518                 if not key.startswith("__")
1519             ]
1520
1521             for key, descr in descr_items:
1522                 # GetSetDescriptorType, GetSetDescriptorType's are not documented yet
1523                 if type(descr) == MethodDescriptorType:
1524                     py_descr2sphinx("   ", fw, descr, "bpy.types", class_name, key)
1525
1526             for key, descr in descr_items:
1527                 if type(descr) == GetSetDescriptorType:
1528                     py_descr2sphinx("   ", fw, descr, "bpy.types", class_name, key)
1529             file.close()
1530
1531         # write fake classes
1532         if _BPY_STRUCT_FAKE:
1533             class_value = bpy.types.Struct.__bases__[0]
1534             fake_bpy_type(
1535                 class_value, _BPY_STRUCT_FAKE,
1536                 "built-in base class for all classes in bpy.types.", use_subclasses=True)
1537
1538         if _BPY_PROP_COLLECTION_FAKE:
1539             class_value = bpy.data.objects.__class__
1540             fake_bpy_type(
1541                 class_value, _BPY_PROP_COLLECTION_FAKE,
1542                 "built-in class used for all collections.", use_subclasses=False)
1543
1544     # operators
1545     def write_ops():
1546         API_BASEURL = "https://developer.blender.org/diffusion/B/browse/master/release/scripts"
1547         API_BASEURL_ADDON = "https://developer.blender.org/diffusion/BA"
1548         API_BASEURL_ADDON_CONTRIB = "https://developer.blender.org/diffusion/BAC"
1549
1550         op_modules = {}
1551         for op in ops.values():
1552             op_modules.setdefault(op.module_name, []).append(op)
1553         del op
1554
1555         for op_module_name, ops_mod in op_modules.items():
1556             filepath = os.path.join(basepath, "bpy.ops.%s.rst" % op_module_name)
1557             file = open(filepath, "w", encoding="utf-8")
1558             fw = file.write
1559
1560             title = "%s Operators" % op_module_name.replace("_", " ").title()
1561
1562             fw(title_string(title, "="))
1563
1564             fw(".. module:: bpy.ops.%s\n\n" % op_module_name)
1565
1566             ops_mod.sort(key=lambda op: op.func_name)
1567
1568             for op in ops_mod:
1569                 args_str = ", ".join(prop.get_arg_default(force=True) for prop in op.args)
1570                 fw(".. function:: %s(%s)\n\n" % (op.func_name, args_str))
1571
1572                 # if the description isn't valid, we output the standard warning
1573                 # with a link to the wiki so that people can help
1574                 if not op.description or op.description == "(undocumented operator)":
1575                     operator_description = undocumented_message('bpy.ops', op.module_name, op.func_name)
1576                 else:
1577                     operator_description = op.description
1578
1579                 fw("   %s\n\n" % operator_description)
1580                 for prop in op.args:
1581                     write_param("   ", fw, prop)
1582                 if op.args:
1583                     fw("\n")
1584
1585                 location = op.get_location()
1586                 if location != (None, None):
1587                     if location[0].startswith("addons_contrib" + os.sep):
1588                         url_base = API_BASEURL_ADDON_CONTRIB
1589                     elif location[0].startswith("addons" + os.sep):
1590                         url_base = API_BASEURL_ADDON
1591                     else:
1592                         url_base = API_BASEURL
1593
1594                     fw("   :file: `%s\\:%d <%s/%s$%d>`_\n\n" %
1595                        (location[0], location[1], url_base, location[0], location[1]))
1596
1597             file.close()
1598
1599     if "bpy.ops" not in EXCLUDE_MODULES:
1600         write_ops()
1601
1602
1603 def write_sphinx_conf_py(basepath):
1604     '''
1605     Write sphinx's conf.py
1606     '''
1607     filepath = os.path.join(basepath, "conf.py")
1608     file = open(filepath, "w", encoding="utf-8")
1609     fw = file.write
1610
1611     fw("import sys, os\n\n")
1612     fw("extensions = ['sphinx.ext.intersphinx']\n\n")
1613     fw("intersphinx_mapping = {'blender_manual': ('https://docs.blender.org/manual/en/dev/', None)}\n\n")
1614     fw("project = 'Blender'\n")
1615     fw("master_doc = 'index'\n")
1616     fw("copyright = u'Blender Foundation'\n")
1617     fw("version = '%s'\n" % BLENDER_VERSION_DOTS)
1618     fw("release = '%s'\n" % BLENDER_VERSION_DOTS)
1619
1620     # Quiet file not in table-of-contents warnings.
1621     fw("exclude_patterns = [\n")
1622     fw("    'include__bmesh.rst',\n")
1623     fw("]\n\n")
1624
1625     fw("html_title = 'Blender %s Python API'\n" % BLENDER_VERSION_DOTS)
1626     fw("html_theme = 'sphinx_rtd_theme'\n")
1627     # not helpful since the source is generated, adds to upload size.
1628     fw("html_copy_source = False\n")
1629     fw("html_show_sphinx = False\n")
1630     fw("html_split_index = True\n")
1631     fw("html_extra_path = ['__/static/favicon.ico', '__/static/blender_logo.svg']\n")
1632     fw("html_favicon = '__/static/favicon.ico'\n")
1633     fw("html_logo = '__/static/blender_logo.svg'\n\n")
1634
1635     # needed for latex, pdf gen
1636     fw("latex_elements = {\n")
1637     fw("  'papersize': 'a4paper',\n")
1638     fw("}\n\n")
1639
1640     fw("latex_documents = [ ('contents', 'contents.tex', 'Blender Index', 'Blender Foundation', 'manual'), ]\n")
1641
1642     # Workaround for useless links leading to compile errors
1643     # See https://github.com/sphinx-doc/sphinx/issues/3866
1644     fw(r"""
1645 from sphinx.domains.python import PythonDomain
1646
1647 class PatchedPythonDomain(PythonDomain):
1648     def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
1649         if 'refspecific' in node:
1650             del node['refspecific']
1651         return super(PatchedPythonDomain, self).resolve_xref(
1652             env, fromdocname, builder, typ, target, node, contnode)
1653
1654 def setup(sphinx):
1655     sphinx.override_domain(PatchedPythonDomain)
1656 """)
1657     # end workaround
1658
1659     file.close()
1660
1661
1662 def execfile(filepath):
1663     global_namespace = {"__file__": filepath, "__name__": "__main__"}
1664     file_handle = open(filepath)
1665     exec(compile(file_handle.read(), filepath, 'exec'), global_namespace)
1666     file_handle.close()
1667
1668
1669 def write_rst_contents(basepath):
1670     '''
1671     Write the rst file of the main page, needed for sphinx (index.html)
1672     '''
1673     filepath = os.path.join(basepath, "index.rst")
1674     file = open(filepath, "w", encoding="utf-8")
1675     fw = file.write
1676
1677     fw(title_string("Blender Python API Documentation", "%", double=True))
1678     fw("\n")
1679     fw("Welcome to the API reference for Blender %s, built %s.\n" %
1680        (BLENDER_VERSION_DOTS, BLENDER_DATE))
1681     fw("\n")
1682
1683     # fw("`A PDF version of this document is also available <%s>`_\n" % BLENDER_PDF_FILENAME)
1684     fw("This site can be downloaded for offline use: `Download the full Documentation (zipped HTML files) <%s>`_\n" %
1685        BLENDER_ZIP_FILENAME)
1686     fw("\n")
1687
1688     if not EXCLUDE_INFO_DOCS:
1689         fw(".. toctree::\n")
1690         fw("   :maxdepth: 1\n")
1691         fw("   :caption: Documentation\n\n")
1692         for info, info_desc in INFO_DOCS:
1693             fw("   %s <%s>\n" % (info_desc, info))
1694         fw("\n")
1695
1696     fw(".. toctree::\n")
1697     fw("   :maxdepth: 1\n")
1698     fw("   :caption: Application Modules\n\n")
1699
1700     app_modules = (
1701         "bpy.context",  # note: not actually a module
1702         "bpy.data",     # note: not actually a module
1703         "bpy.ops",
1704         "bpy.types",
1705
1706         # py modules
1707         "bpy.utils",
1708         "bpy.utils.previews",
1709         "bpy.path",
1710         "bpy.app",
1711
1712         # C modules
1713         "bpy.props",
1714     )
1715
1716     for mod in app_modules:
1717         if mod not in EXCLUDE_MODULES:
1718             fw("   %s\n" % mod)
1719     fw("\n")
1720
1721     fw(".. toctree::\n")
1722     fw("   :maxdepth: 1\n")
1723     fw("   :caption: Standalone Modules\n\n")
1724
1725     standalone_modules = (
1726         # submodules are added in parent page
1727         "mathutils", "freestyle", "bgl", "blf", "gpu", "gpu_extras",
1728         "aud", "bpy_extras", "idprop.types", "bmesh",
1729     )
1730
1731     for mod in standalone_modules:
1732         if mod not in EXCLUDE_MODULES:
1733             fw("   %s\n" % mod)
1734     fw("\n")
1735
1736     # special case, this 'bmesh.ops.rst' is extracted from C source
1737     if "bmesh.ops" not in EXCLUDE_MODULES:
1738         execfile(os.path.join(SCRIPT_DIR, "rst_from_bmesh_opdefines.py"))
1739
1740     file.close()
1741
1742
1743 def write_rst_bpy(basepath):
1744     '''
1745     Write rst file of bpy module (disabled by default)
1746     '''
1747     if ARGS.bpy:
1748         filepath = os.path.join(basepath, "bpy.rst")
1749         file = open(filepath, "w", encoding="utf-8")
1750         fw = file.write
1751
1752         fw("\n")
1753
1754         title = ":mod:`bpy` --- Blender Python Module"
1755
1756         fw(title_string(title, "="))
1757
1758         fw(".. module:: bpy.types\n\n")
1759         file.close()
1760
1761
1762 def write_rst_types_index(basepath):
1763     '''
1764     Write the rst file of bpy.types module (index)
1765     '''
1766     if "bpy.types" not in EXCLUDE_MODULES:
1767         filepath = os.path.join(basepath, "bpy.types.rst")
1768         file = open(filepath, "w", encoding="utf-8")
1769         fw = file.write
1770         fw(title_string("Types (bpy.types)", "="))
1771         fw(".. toctree::\n")
1772         fw("   :glob:\n\n")
1773         fw("   bpy.types.*\n\n")
1774         file.close()
1775
1776
1777 def write_rst_ops_index(basepath):
1778     '''
1779     Write the rst file of bpy.ops module (index)
1780     '''
1781     if "bpy.ops" not in EXCLUDE_MODULES:
1782         filepath = os.path.join(basepath, "bpy.ops.rst")
1783         file = open(filepath, "w", encoding="utf-8")
1784         fw = file.write
1785         fw(title_string("Operators (bpy.ops)", "="))
1786         write_example_ref("", fw, "bpy.ops")
1787         fw(".. toctree::\n")
1788         fw("   :glob:\n\n")
1789         fw("   bpy.ops.*\n\n")
1790         file.close()
1791
1792
1793 def write_rst_data(basepath):
1794     '''
1795     Write the rst file of bpy.data module
1796     '''
1797     if "bpy.data" not in EXCLUDE_MODULES:
1798         # not actually a module, only write this file so we
1799         # can reference in the TOC
1800         filepath = os.path.join(basepath, "bpy.data.rst")
1801         file = open(filepath, "w", encoding="utf-8")
1802         fw = file.write
1803         fw(title_string("Data Access (bpy.data)", "="))
1804         fw(".. module:: bpy\n")
1805         fw("\n")
1806         fw("This module is used for all Blender/Python access.\n")
1807         fw("\n")
1808         fw(".. data:: data\n")
1809         fw("\n")
1810         fw("   Access to Blender's internal data\n")
1811         fw("\n")
1812         fw("   :type: :class:`bpy.types.BlendData`\n")
1813         fw("\n")
1814         fw(".. literalinclude:: ../examples/bpy.data.py\n")
1815         file.close()
1816
1817         EXAMPLE_SET_USED.add("bpy.data")
1818
1819
1820 def write_rst_importable_modules(basepath):
1821     '''
1822     Write the rst files of importable modules
1823     '''
1824     importable_modules = {
1825         # Python_modules
1826         "bpy.path": "Path Utilities",
1827         "bpy.utils": "Utilities",
1828         "bpy_extras": "Extra Utilities",
1829         "gpu_extras": "GPU Utilities",
1830
1831         # C_modules
1832         "aud": "Audio System",
1833         "blf": "Font Drawing",
1834         "gpu": "GPU Shader Module",
1835         "gpu.types": "GPU Types",
1836         "gpu.matrix": "GPU Matrix",
1837         "gpu.select": "GPU Select",
1838         "gpu.shader": "GPU Shader",
1839         "bmesh": "BMesh Module",
1840         "bmesh.types": "BMesh Types",
1841         "bmesh.utils": "BMesh Utilities",
1842         "bmesh.geometry": "BMesh Geometry Utilities",
1843         "bpy.app": "Application Data",
1844         "bpy.app.handlers": "Application Handlers",
1845         "bpy.app.translations": "Application Translations",
1846         "bpy.app.icons": "Application Icons",
1847         "bpy.app.timers": "Application Timers",
1848         "bpy.props": "Property Definitions",
1849         "idprop.types": "ID Property Access",
1850         "mathutils": "Math Types & Utilities",
1851         "mathutils.geometry": "Geometry Utilities",
1852         "mathutils.bvhtree": "BVHTree Utilities",
1853         "mathutils.kdtree": "KDTree Utilities",
1854         "mathutils.interpolate": "Interpolation Utilities",
1855         "mathutils.noise": "Noise Utilities",
1856         "freestyle": "Freestyle Module",
1857         "freestyle.types": "Freestyle Types",
1858         "freestyle.predicates": "Freestyle Predicates",
1859         "freestyle.functions": "Freestyle Functions",
1860         "freestyle.chainingiterators": "Freestyle Chaining Iterators",
1861         "freestyle.shaders": "Freestyle Shaders",
1862         "freestyle.utils": "Freestyle Utilities",
1863     }
1864     for mod_name, mod_descr in importable_modules.items():
1865         if mod_name not in EXCLUDE_MODULES:
1866             module = __import__(mod_name,
1867                                 fromlist=[mod_name.rsplit(".", 1)[-1]])
1868             pymodule2sphinx(basepath, mod_name, module, mod_descr)
1869
1870
1871 def copy_handwritten_rsts(basepath):
1872
1873     # info docs
1874     if not EXCLUDE_INFO_DOCS:
1875         for info, info_desc in INFO_DOCS:
1876             shutil.copy2(os.path.join(RST_DIR, info), basepath)
1877
1878     # TODO put this docs in Blender's code and use import as per modules above
1879     handwritten_modules = [
1880         "bgl",  # "Blender OpenGl wrapper"
1881         "bmesh.ops",  # generated by rst_from_bmesh_opdefines.py
1882
1883         # includes...
1884         "include__bmesh",
1885     ]
1886
1887     for mod_name in handwritten_modules:
1888         if mod_name not in EXCLUDE_MODULES:
1889             # copy2 keeps time/date stamps
1890             shutil.copy2(os.path.join(RST_DIR, "%s.rst" % mod_name), basepath)
1891
1892     # changelog
1893     shutil.copy2(os.path.join(RST_DIR, "change_log.rst"), basepath)
1894
1895     # copy images, could be smarter but just glob for now.
1896     for f in os.listdir(RST_DIR):
1897         if f.endswith(".png"):
1898             shutil.copy2(os.path.join(RST_DIR, f), basepath)
1899
1900
1901 def copy_handwritten_extra(basepath):
1902     for f_src in EXTRA_SOURCE_FILES:
1903         if os.sep != "/":
1904             f_src = os.sep.join(f_src.split("/"))
1905
1906         f_dst = f_src.replace("..", "__")
1907
1908         f_src = os.path.join(RST_DIR, f_src)
1909         f_dst = os.path.join(basepath, f_dst)
1910
1911         os.makedirs(os.path.dirname(f_dst), exist_ok=True)
1912
1913         shutil.copy2(f_src, f_dst)
1914
1915
1916 def rna2sphinx(basepath):
1917
1918     try:
1919         os.mkdir(basepath)
1920     except:
1921         pass
1922
1923     # sphinx setup
1924     write_sphinx_conf_py(basepath)
1925
1926     # main page
1927     write_rst_contents(basepath)
1928
1929     # context
1930     if "bpy.context" not in EXCLUDE_MODULES:
1931         # one of a kind, context doc (uses ctypes to extract info!)
1932         # doesn't work on mac and windows
1933         if PLATFORM not in {"darwin", "windows"}:
1934             pycontext2sphinx(basepath)
1935
1936     # internal modules
1937     write_rst_bpy(basepath)                 # bpy, disabled by default
1938     write_rst_types_index(basepath)         # bpy.types
1939     write_rst_ops_index(basepath)           # bpy.ops
1940     pyrna2sphinx(basepath)                  # bpy.types.* and bpy.ops.*
1941     write_rst_data(basepath)                # bpy.data
1942     write_rst_importable_modules(basepath)
1943
1944     # copy the other rsts
1945     copy_handwritten_rsts(basepath)
1946
1947     # copy source files referenced
1948     copy_handwritten_extra(basepath)
1949
1950
1951 def align_sphinx_in_to_sphinx_in_tmp(dir_src, dir_dst):
1952     '''
1953     Move changed files from SPHINX_IN_TMP to SPHINX_IN
1954     '''
1955     import filecmp
1956
1957     # possible the dir doesn't exist when running recursively
1958     os.makedirs(dir_dst, exist_ok=True)
1959
1960     sphinx_dst_files = set(os.listdir(dir_dst))
1961     sphinx_src_files = set(os.listdir(dir_src))
1962
1963     # remove deprecated files that have been removed
1964     for f in sorted(sphinx_dst_files):
1965         if f not in sphinx_src_files:
1966             BPY_LOGGER.debug("\tdeprecated: %s" % f)
1967             f_dst = os.path.join(dir_dst, f)
1968             if os.path.isdir(f_dst):
1969                 shutil.rmtree(f_dst, True)
1970             else:
1971                 os.remove(f_dst)
1972
1973     # freshen with new files.
1974     for f in sorted(sphinx_src_files):
1975         f_src = os.path.join(dir_src, f)
1976         f_dst = os.path.join(dir_dst, f)
1977
1978         if os.path.isdir(f_src):
1979             align_sphinx_in_to_sphinx_in_tmp(f_src, f_dst)
1980         else:
1981             do_copy = True
1982             if f in sphinx_dst_files:
1983                 if filecmp.cmp(f_src, f_dst):
1984                     do_copy = False
1985
1986             if do_copy:
1987                 BPY_LOGGER.debug("\tupdating: %s" % f)
1988                 shutil.copy(f_src, f_dst)
1989
1990
1991 def refactor_sphinx_log(sphinx_logfile):
1992     refactored_log = []
1993     with open(sphinx_logfile, "r", encoding="utf-8") as original_logfile:
1994         lines = set(original_logfile.readlines())
1995         for line in lines:
1996             if 'warning' in line.lower() or 'error' in line.lower():
1997                 line = line.strip().split(None, 2)
1998                 if len(line) == 3:
1999                     location, kind, msg = line
2000                     location = os.path.relpath(location, start=SPHINX_IN)
2001                     refactored_log.append((kind, location, msg))
2002     with open(sphinx_logfile, "w", encoding="utf-8") as refactored_logfile:
2003         for log in sorted(refactored_log):
2004             refactored_logfile.write("%-12s %s\n             %s\n" % log)
2005
2006
2007 def monkey_patch():
2008     filepath = os.path.join(SCRIPT_DIR, "sphinx_doc_gen_monkeypatch.py")
2009     global_namespace = {"__file__": filepath, "__name__": "__main__"}
2010     file = open(filepath, 'rb')
2011     exec(compile(file.read(), filepath, 'exec'), global_namespace)
2012     file.close()
2013
2014
2015 def main():
2016
2017     # first monkey patch to load in fake members
2018     monkey_patch()
2019
2020     # eventually, create the dirs
2021     for dir_path in [ARGS.output_dir, SPHINX_IN]:
2022         if not os.path.exists(dir_path):
2023             os.mkdir(dir_path)
2024
2025     # eventually, log in files
2026     if ARGS.log:
2027         bpy_logfile = os.path.join(ARGS.output_dir, ".bpy.log")
2028         bpy_logfilehandler = logging.FileHandler(bpy_logfile, mode="w")
2029         bpy_logfilehandler.setLevel(logging.DEBUG)
2030         BPY_LOGGER.addHandler(bpy_logfilehandler)
2031
2032         # using a FileHandler seems to disable the stdout, so we add a StreamHandler
2033         bpy_log_stdout_handler = logging.StreamHandler(stream=sys.stdout)
2034         bpy_log_stdout_handler.setLevel(logging.DEBUG)
2035         BPY_LOGGER.addHandler(bpy_log_stdout_handler)
2036
2037     # in case of out-of-source build, copy the needed dirs
2038     if ARGS.output_dir != SCRIPT_DIR:
2039         # examples dir
2040         examples_dir_copy = os.path.join(ARGS.output_dir, "examples")
2041         if os.path.exists(examples_dir_copy):
2042             shutil.rmtree(examples_dir_copy, True)
2043         shutil.copytree(EXAMPLES_DIR,
2044                         examples_dir_copy,
2045                         ignore=shutil.ignore_patterns(*(".svn",)),
2046                         copy_function=shutil.copy)
2047
2048     # dump the api in rst files
2049     if os.path.exists(SPHINX_IN_TMP):
2050         shutil.rmtree(SPHINX_IN_TMP, True)
2051
2052     rna2sphinx(SPHINX_IN_TMP)
2053
2054     if ARGS.full_rebuild:
2055         # only for full updates
2056         shutil.rmtree(SPHINX_IN, True)
2057         shutil.copytree(SPHINX_IN_TMP,
2058                         SPHINX_IN,
2059                         copy_function=shutil.copy)
2060         if ARGS.sphinx_build and os.path.exists(SPHINX_OUT):
2061             shutil.rmtree(SPHINX_OUT, True)
2062         if ARGS.sphinx_build_pdf and os.path.exists(SPHINX_OUT_PDF):
2063             shutil.rmtree(SPHINX_OUT_PDF, True)
2064     else:
2065         # move changed files in SPHINX_IN
2066         align_sphinx_in_to_sphinx_in_tmp(SPHINX_IN_TMP, SPHINX_IN)
2067
2068     # report which example files weren't used
2069     EXAMPLE_SET_UNUSED = EXAMPLE_SET - EXAMPLE_SET_USED
2070     if EXAMPLE_SET_UNUSED:
2071         BPY_LOGGER.debug("\nUnused examples found in '%s'..." % EXAMPLES_DIR)
2072         for f in sorted(EXAMPLE_SET_UNUSED):
2073             BPY_LOGGER.debug("    %s.py" % f)
2074         BPY_LOGGER.debug("  %d total\n" % len(EXAMPLE_SET_UNUSED))
2075
2076     # eventually, build the html docs
2077     if ARGS.sphinx_build:
2078         import subprocess
2079         subprocess.call(SPHINX_BUILD)
2080
2081         # sphinx-build log cleanup+sort
2082         if ARGS.log:
2083             if os.stat(SPHINX_BUILD_LOG).st_size:
2084                 refactor_sphinx_log(SPHINX_BUILD_LOG)
2085
2086     # eventually, build the pdf docs
2087     if ARGS.sphinx_build_pdf:
2088         import subprocess
2089         subprocess.call(SPHINX_BUILD_PDF)
2090         subprocess.call(SPHINX_MAKE_PDF, stdout=SPHINX_MAKE_PDF_STDOUT)
2091
2092         # sphinx-build log cleanup+sort
2093         if ARGS.log:
2094             if os.stat(SPHINX_BUILD_PDF_LOG).st_size:
2095                 refactor_sphinx_log(SPHINX_BUILD_PDF_LOG)
2096
2097     # eventually, prepare the dir to be deployed online (REFERENCE_PATH)
2098     if ARGS.pack_reference:
2099
2100         if ARGS.sphinx_build:
2101             # delete REFERENCE_PATH
2102             if os.path.exists(REFERENCE_PATH):
2103                 shutil.rmtree(REFERENCE_PATH, True)
2104
2105             # copy SPHINX_OUT to the REFERENCE_PATH
2106             ignores = ('.doctrees', 'objects.inv', '.buildinfo')
2107             shutil.copytree(SPHINX_OUT,
2108                             REFERENCE_PATH,
2109                             ignore=shutil.ignore_patterns(*ignores))
2110
2111             # zip REFERENCE_PATH
2112             basename = os.path.join(ARGS.output_dir, REFERENCE_NAME)
2113             tmp_path = shutil.make_archive(basename, 'zip',
2114                                            root_dir=ARGS.output_dir,
2115                                            base_dir=REFERENCE_NAME)
2116             final_path = os.path.join(REFERENCE_PATH, BLENDER_ZIP_FILENAME)
2117             os.rename(tmp_path, final_path)
2118
2119         if ARGS.sphinx_build_pdf:
2120             # copy the pdf to REFERENCE_PATH
2121             shutil.copy(os.path.join(SPHINX_OUT_PDF, "contents.pdf"),
2122                         os.path.join(REFERENCE_PATH, BLENDER_PDF_FILENAME))
2123
2124     sys.exit()
2125
2126
2127 if __name__ == '__main__':
2128     main()