diff options
author | Campbell Barton <ideasman42@gmail.com> | 2010-09-03 13:21:40 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2010-09-03 13:21:40 +0400 |
commit | 52cefa4bc1104231cf6c6ef5b12124df135e2914 (patch) | |
tree | 8ab3a8e3578e73ef20cc1955e3e06786293a53a0 /source/blender | |
parent | b0c4b1216d9f298d688f2bd7ad5336473664c900 (diff) |
sphinx doc gen
- use 3 column lists for inherited props, funcs and for references to save on vertical space.
- use the blender version string for the upload path and PDF name.
Diffstat (limited to 'source/blender')
-rw-r--r-- | source/blender/python/doc/sphinx_doc_gen.py | 32 | ||||
-rwxr-xr-x | source/blender/python/doc/sphinx_doc_gen.sh | 13 |
2 files changed, 32 insertions, 13 deletions
diff --git a/source/blender/python/doc/sphinx_doc_gen.py b/source/blender/python/doc/sphinx_doc_gen.py index 06d1a9021b8..5d70e62dde8 100644 --- a/source/blender/python/doc/sphinx_doc_gen.py +++ b/source/blender/python/doc/sphinx_doc_gen.py @@ -307,6 +307,9 @@ def rna2sphinx(BASEPATH): if bpy.app.build_revision != "Unknown": version_string = version_string + " r" + bpy.app.build_revision + # for use with files + version_string_fp = "_".join(str(v) for v in bpy.app.version) + fw("project = 'Blender'\n") # fw("master_doc = 'index'\n") fw("copyright = u'Blender Foundation'\n") @@ -336,7 +339,7 @@ def rna2sphinx(BASEPATH): fw("\n") fw("An introduction to Blender and Python can be found at <http://wiki.blender.org/index.php/Dev:2.5/Py/API/Intro>\n") fw("\n") - fw("`A PDF version of this document is also available <blender_python_reference_250.pdf>`__\n") + fw("`A PDF version of this document is also available <blender_python_reference_%s.pdf>`__\n" % version_string_fp) fw("\n") fw(".. warning:: The Python API in Blender is **UNSTABLE**, It should only be used for testing, any script written now may break in future releases.\n") fw(" \n") @@ -636,20 +639,24 @@ def rna2sphinx(BASEPATH): if _BPY_STRUCT_FAKE: for key, descr in descr_items: if type(descr) == GetSetDescriptorType: - lines.append("* :class:`%s.%s`\n" % (_BPY_STRUCT_FAKE, key)) + lines.append(" * :class:`%s.%s`\n" % (_BPY_STRUCT_FAKE, key)) for base in bases: for prop in base.properties: - lines.append("* :class:`%s.%s`\n" % (base.identifier, prop.identifier)) + lines.append(" * :class:`%s.%s`\n" % (base.identifier, prop.identifier)) for identifier, py_prop in base.get_py_properties(): - lines.append("* :class:`%s.%s`\n" % (base.identifier, identifier)) + lines.append(" * :class:`%s.%s`\n" % (base.identifier, identifier)) for identifier, py_prop in base.get_py_properties(): - lines.append("* :class:`%s.%s`\n" % (base.identifier, identifier)) + lines.append(" * :class:`%s.%s`\n" % (base.identifier, identifier)) if lines: fw(".. rubric:: Inherited Properties\n\n") + + fw(".. hlist::\n") + fw(" :columns: 3\n\n") + for line in lines: fw(line) fw("\n") @@ -661,16 +668,20 @@ def rna2sphinx(BASEPATH): if _BPY_STRUCT_FAKE: for key, descr in descr_items: if type(descr) == MethodDescriptorType: - lines.append("* :class:`%s.%s`\n" % (_BPY_STRUCT_FAKE, key)) + lines.append(" * :class:`%s.%s`\n" % (_BPY_STRUCT_FAKE, key)) for base in bases: for func in base.functions: - lines.append("* :class:`%s.%s`\n" % (base.identifier, func.identifier)) + lines.append(" * :class:`%s.%s`\n" % (base.identifier, func.identifier)) for identifier, py_func in base.get_py_functions(): - lines.append("* :class:`%s.%s`\n" % (base.identifier, identifier)) + lines.append(" * :class:`%s.%s`\n" % (base.identifier, identifier)) if lines: fw(".. rubric:: Inherited Functions\n\n") + + fw(".. hlist::\n") + fw(" :columns: 3\n\n") + for line in lines: fw(line) fw("\n") @@ -682,11 +693,14 @@ def rna2sphinx(BASEPATH): # use this otherwise it gets in the index for a normal heading. fw(".. rubric:: References\n\n") + fw(".. hlist::\n") + fw(" :columns: 3\n\n") + for ref in struct.references: ref_split = ref.split(".") if len(ref_split) > 2: ref = ref_split[-2] + "." + ref_split[-1] - fw("* :class:`%s`\n" % ref) + fw(" * :class:`%s`\n" % ref) fw("\n") diff --git a/source/blender/python/doc/sphinx_doc_gen.sh b/source/blender/python/doc/sphinx_doc_gen.sh index 4f5f55af2bd..989424ba7eb 100755 --- a/source/blender/python/doc/sphinx_doc_gen.sh +++ b/source/blender/python/doc/sphinx_doc_gen.sh @@ -5,7 +5,12 @@ BLENDER="./blender.bin" SSH_HOST="ideasman42@emo.blender.org" -SSH_UPLOAD="/data/www/vhosts/www.blender.org/documentation/250PythonDoc" +SSH_UPLOAD="/data/www/vhosts/www.blender.org/documentation" # blender_python_api_VERSION, added after + +# sed string from hell, 'Blender 2.53 (sub 1) Build' --> '2_53_1' +# "_".join(str(v) for v in bpy.app.version) +BLENDER_VERSION=`$BLENDER --version | cut -f2-4 -d" " | sed 's/(//g' | sed 's/)//g' | sed 's/ sub /./g' | sed 's/\./_/g'` +SSH_UPLOAD_FULL=$SSH_UPLOAD/"blender_python_api_"$BLENDER_VERSION # dont delete existing docs, now partial updates are used for quick builds. $BLENDER --background --python ./source/blender/python/doc/sphinx_doc_gen.py @@ -13,12 +18,12 @@ $BLENDER --background --python ./source/blender/python/doc/sphinx_doc_gen.py # html sphinx-build source/blender/python/doc/sphinx-in source/blender/python/doc/sphinx-out cp source/blender/python/doc/sphinx-out/contents.html source/blender/python/doc/sphinx-out/index.html -ssh ideasman42@emo.blender.org 'rm -rf '$SSH_UPLOAD'/*' -rsync --progress -avze "ssh -p 22" /b/source/blender/python/doc/sphinx-out/* $SSH_HOST:$SSH_UPLOAD/ +ssh ideasman42@emo.blender.org 'rm -rf '$SSH_UPLOAD_FULL'/*' +rsync --progress -avze "ssh -p 22" /b/source/blender/python/doc/sphinx-out/* $SSH_HOST:$SSH_UPLOAD_FULL/ # pdf sphinx-build -b latex source/blender/python/doc/sphinx-in source/blender/python/doc/sphinx-out cd source/blender/python/doc/sphinx-out make cd ../../../../../ -rsync --progress -avze "ssh -p 22" source/blender/python/doc/sphinx-out/contents.pdf $SSH_HOST:$SSH_UPLOAD/blender_python_reference_250.pdf +rsync --progress -avze "ssh -p 22" source/blender/python/doc/sphinx-out/contents.pdf $SSH_HOST:$SSH_UPLOAD_FULL/blender_python_reference_$BLENDER_VERSION.pdf |