bartvdbraak/blender
1
0
Fork 4
Code Issues 4 Pull Requests 1 Actions 1 Packages Projects Releases Wiki Activity
a39329be5c
blender/doc/python_api/sphinx_doc_gen.sh

131 lines
4.8 KiB
Bash
Raw Normal View History

merge own commits into render branch into trunk since 27560 27562, 27570, 27571, 27574, 27576, 27577, 27579, 27590, 27591, 27594, 27595, 27596, 27599, 27605, 27611, 27612, 27613, 27614, 27623
2010-03-20 16:41:01 +00:00
#!/bin/sh
# run from the blender source dir
# bash source/blender/python/doc/sphinx_doc_gen.sh
sphinx doc generation - include default values as well as min/max. - partial rebuilds, so we dont have to build all docs each time, only the changed files.
2010-05-03 15:52:15 +00:00
# ssh upload means you need an account on the server
merge own commits into render branch into trunk since 27560 27562, 27570, 27571, 27574, 27576, 27577, 27579, 27590, 27591, 27594, 27595, 27596, 27599, 27605, 27611, 27612, 27613, 27614, 27623
2010-03-20 16:41:01 +00:00
move wiki api intro and overview docs into the api reference docs. Updated docs since some parts still were from beta still.
2011-08-25 04:25:33 +00:00
# ----------------------------------------------------------------------------
# Upload vars
# disable for testing
DO_UPLOAD=true
- include enum names and descriptions in sphinx generated documentation - add descriptions for operator bl_options
2011-09-15 16:15:24 +00:00
DO_EXE_BLENDER=true
DO_OUT_HTML=true
Disable PDF doc since its giving errors with latex indentation. upload the zipped version of HTML docs instead.
2012-02-10 15:00:55 +00:00
DO_OUT_HTML_ZIP=true
DO_OUT_PDF=false
- include enum names and descriptions in sphinx generated documentation - add descriptions for operator bl_options
2011-09-15 16:15:24 +00:00
move wiki api intro and overview docs into the api reference docs. Updated docs since some parts still were from beta still.
2011-08-25 04:25:33 +00:00
merge own commits into render branch into trunk since 27560 27562, 27570, 27571, 27574, 27576, 27577, 27579, 27590, 27591, 27594, 27595, 27596, 27599, 27605, 27611, 27612, 27613, 27614, 27623
2010-03-20 16:41:01 +00:00
BLENDER="./blender.bin"
- cmake was missing an inclide (IDE's wouldnt index) - made doc generation always sumlink newly built docs to static URL. http://www.blender.org/documentation/250PythonDoc/
2011-02-06 10:18:20 +00:00
SSH_USER="ideasman42"
SSH_HOST=$SSH_USER"@emo.blender.org"
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.
2010-09-03 09:21:40 +00:00
SSH_UPLOAD="/data/www/vhosts/www.blender.org/documentation" # blender_python_api_VERSION, added after
move wiki api intro and overview docs into the api reference docs. Updated docs since some parts still were from beta still.
2011-08-25 04:25:33 +00:00
# ----------------------------------------------------------------------------
# Blender Version & Info
- cmake was missing an inclide (IDE's wouldnt index) - made doc generation always sumlink newly built docs to static URL. http://www.blender.org/documentation/250PythonDoc/
2011-02-06 10:18:20 +00:00
# 'Blender 2.53 (sub 1) Build' --> '2_53_1' as a shell script.
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.
2010-09-03 09:21:40 +00:00
# "_".join(str(v) for v in bpy.app.version)
[#23673] Modifier construction gives correct result in viewport but incorrect in render. When there are 2+ consecutive deform modifiers, the second modifier was getting incorrect normals, this only showed up for the displace modifier since its the only deform modifier that uses vertex normals. It would have been easy to fix this by always calculating normals on deform modifiers, but slow. To fix this I added a function to check if a deform modifier needs normals, so the normal calculation function only runs if there are 2 modifiers in a row and the second uses normals.
2010-09-30 10:51:36 +00:00
# custom blender vars
== python api doc == First commit to make some structure in doc/ directory. - moved source/blender/python/doc -> doc/python_api - moved source/gameengine/PyDoc/*.rst -> doc/python_api/rst - modified accordingly sphinx_doc_gen.py and sphinx_doc_gen.sh (later on I'll try alternative/ scripts by neXyon as promised :) - source/gameengine/PyDoc/ is still there because contains epydoc stuff for the bge, will ask more and look into it later
2010-10-13 10:42:33 +00:00
blender_srcdir=$(dirname $0)/../../
modification to api docs so release point to: http://www.blender.org/documentation/blender_python_api_2_57b_release Development versions point to: http://www.blender.org/documentation/blender_python_api_2_57_0 This way updates to api docs after release wont overwrite release docs.
2011-04-01 15:13:58 +00:00
blender_version=$(grep "BLENDER_VERSION\s" $blender_srcdir/source/blender/blenkernel/BKE_blender.h | awk '{print $3}')
blender_version_char=$(grep BLENDER_VERSION_CHAR $blender_srcdir/source/blender/blenkernel/BKE_blender.h | awk '{print $3}')
blender_version_cycle=$(grep BLENDER_VERSION_CYCLE $blender_srcdir/source/blender/blenkernel/BKE_blender.h | awk '{print $3}')
blender_subversion=$(grep BLENDER_SUBVERSION $blender_srcdir/source/blender/blenkernel/BKE_blender.h | awk '{print $3}')
if [ "$blender_version_cycle" == "release" ]
then
BLENDER_VERSION=$(expr $blender_version / 100)_$(expr $blender_version % 100)$blender_version_char"_release"
else
BLENDER_VERSION=$(expr $blender_version / 100)_$(expr $blender_version % 100)_$blender_subversion
fi
[#23673] Modifier construction gives correct result in viewport but incorrect in render. When there are 2+ consecutive deform modifiers, the second modifier was getting incorrect normals, this only showed up for the displace modifier since its the only deform modifier that uses vertex normals. It would have been easy to fix this by always calculating normals on deform modifiers, but slow. To fix this I added a function to check if a deform modifier needs normals, so the normal calculation function only runs if there are 2 modifiers in a row and the second uses normals.
2010-09-30 10:51:36 +00:00
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.
2010-09-03 09:21:40 +00:00
SSH_UPLOAD_FULL=$SSH_UPLOAD/"blender_python_api_"$BLENDER_VERSION
merge own commits into render branch into trunk since 27560 27562, 27570, 27571, 27574, 27576, 27577, 27579, 27590, 27591, 27594, 27595, 27596, 27599, 27605, 27611, 27612, 27613, 27614, 27623
2010-03-20 16:41:01 +00:00
- include enum names and descriptions in sphinx generated documentation - add descriptions for operator bl_options
2011-09-15 16:15:24 +00:00
SPHINXBASE=doc/python_api
== python api doc == First commit to make some structure in doc/ directory. - moved source/blender/python/doc -> doc/python_api - moved source/gameengine/PyDoc/*.rst -> doc/python_api/rst - modified accordingly sphinx_doc_gen.py and sphinx_doc_gen.sh (later on I'll try alternative/ scripts by neXyon as promised :) - source/gameengine/PyDoc/ is still there because contains epydoc stuff for the bge, will ask more and look into it later
2010-10-13 10:42:33 +00:00
move wiki api intro and overview docs into the api reference docs. Updated docs since some parts still were from beta still.
2011-08-25 04:25:33 +00:00
# ----------------------------------------------------------------------------
# Generate reStructuredText (blender/python only)
- include enum names and descriptions in sphinx generated documentation - add descriptions for operator bl_options
2011-09-15 16:15:24 +00:00
if $DO_EXE_BLENDER ; then
# dont delete existing docs, now partial updates are used for quick builds.
pass -noaudio when running blender for various utilities - doc-gen and tests.
2011-10-19 21:55:27 +00:00
$BLENDER --background -noaudio --factory-startup --python $SPHINXBASE/sphinx_doc_gen.py
- include enum names and descriptions in sphinx generated documentation - add descriptions for operator bl_options
2011-09-15 16:15:24 +00:00
fi
merge own commits into render branch into trunk since 27560 27562, 27570, 27571, 27574, 27576, 27577, 27579, 27590, 27591, 27594, 27595, 27596, 27599, 27605, 27611, 27612, 27613, 27614, 27623
2010-03-20 16:41:01 +00:00
minor improvements to sphinx doc main page
2011-04-13 14:43:11 +00:00
move wiki api intro and overview docs into the api reference docs. Updated docs since some parts still were from beta still.
2011-08-25 04:25:33 +00:00
# ----------------------------------------------------------------------------
# Generate HTML (sphinx)
merge own commits into render branch into trunk since 27560 27562, 27570, 27571, 27574, 27576, 27577, 27579, 27590, 27591, 27594, 27595, 27596, 27599, 27605, 27611, 27612, 27613, 27614, 27623
2010-03-20 16:41:01 +00:00
- include enum names and descriptions in sphinx generated documentation - add descriptions for operator bl_options
2011-09-15 16:15:24 +00:00
if $DO_OUT_HTML ; then
# sphinx-build -n -b html $SPHINXBASE/sphinx-in $SPHINXBASE/sphinx-out
# annoying bug in sphinx makes it very slow unless we do this. should report.
cd $SPHINXBASE
minor fixes - new compositor could use uninitialized var - profile conversion could use uninitialized var - set better warnings for clang+cmake. - remove picky warnings from sphinx doc gen shell script.
2012-06-11 12:13:41 +00:00
sphinx-build -b html sphinx-in sphinx-out
Disable PDF doc since its giving errors with latex indentation. upload the zipped version of HTML docs instead.
2012-02-10 15:00:55 +00:00
py api docs - remove sphinx .doctree before zipping, saves some space 18mb --> 3.1 mb
2012-02-12 19:55:25 +00:00
# XXX, saves space on upload and zip, should move HTML outside
# and zip up there, for now this is OK
rm -rf sphinx-out/.doctrees
# incase we have a zip already
rm -f blender_python_reference_$BLENDER_VERSION.zip
Disable PDF doc since its giving errors with latex indentation. upload the zipped version of HTML docs instead.
2012-02-10 15:00:55 +00:00
# ------------------------------------------------------------------------
# ZIP the HTML dir for upload
if $DO_OUT_HTML_ZIP ; then
# lame, temp rename dir
mv sphinx-out blender_python_reference_$BLENDER_VERSION
zip -r -9 blender_python_reference_$BLENDER_VERSION.zip blender_python_reference_$BLENDER_VERSION
mv blender_python_reference_$BLENDER_VERSION sphinx-out
fi
- include enum names and descriptions in sphinx generated documentation - add descriptions for operator bl_options
2011-09-15 16:15:24 +00:00
cd -
fi
automatically update the redirect from http://www.blender.org/documentation/250PythonDoc/ when uploading docs
2011-07-28 03:08:35 +00:00
- cmake was missing an inclide (IDE's wouldnt index) - made doc generation always sumlink newly built docs to static URL. http://www.blender.org/documentation/250PythonDoc/
2011-02-06 10:18:20 +00:00
move wiki api intro and overview docs into the api reference docs. Updated docs since some parts still were from beta still.
2011-08-25 04:25:33 +00:00
# ----------------------------------------------------------------------------
# Generate PDF (sphinx/laytex)
- cmake was missing an inclide (IDE's wouldnt index) - made doc generation always sumlink newly built docs to static URL. http://www.blender.org/documentation/250PythonDoc/
2011-02-06 10:18:20 +00:00
- include enum names and descriptions in sphinx generated documentation - add descriptions for operator bl_options
2011-09-15 16:15:24 +00:00
if $DO_OUT_PDF ; then
sphinx-build -n -b latex $SPHINXBASE/sphinx-in $SPHINXBASE/sphinx-out
make -C $SPHINXBASE/sphinx-out
mv $SPHINXBASE/sphinx-out/contents.pdf $SPHINXBASE/sphinx-out/blender_python_reference_$BLENDER_VERSION.pdf
fi
move wiki api intro and overview docs into the api reference docs. Updated docs since some parts still were from beta still.
2011-08-25 04:25:33 +00:00
Disable PDF doc since its giving errors with latex indentation. upload the zipped version of HTML docs instead.
2012-02-10 15:00:55 +00:00
move wiki api intro and overview docs into the api reference docs. Updated docs since some parts still were from beta still.
2011-08-25 04:25:33 +00:00
# ----------------------------------------------------------------------------
# Upload to blender servers, comment this section for testing
if $DO_UPLOAD ; then
cp $SPHINXBASE/sphinx-out/contents.html $SPHINXBASE/sphinx-out/index.html
ssh $SSH_USER@emo.blender.org 'rm -rf '$SSH_UPLOAD_FULL'/*'
rsync --progress -avze "ssh -p 22" $SPHINXBASE/sphinx-out/* $SSH_HOST:$SSH_UPLOAD_FULL/
## symlink the dir to a static URL
#ssh $SSH_USER@emo.blender.org 'rm '$SSH_UPLOAD'/250PythonDoc && ln -s '$SSH_UPLOAD_FULL' '$SSH_UPLOAD'/250PythonDoc'
# better redirect
ssh $SSH_USER@emo.blender.org 'echo "<html><head><title>Redirecting...</title><meta http-equiv=\"REFRESH\" content=\"0;url=../blender_python_api_'$BLENDER_VERSION'/\"></head><body>Redirecting...</body></html>" > '$SSH_UPLOAD'/250PythonDoc/index.html'
Disable PDF doc since its giving errors with latex indentation. upload the zipped version of HTML docs instead.
2012-02-10 15:00:55 +00:00
if $DO_OUT_PDF ; then
# rename so local PDF has matching name.
rsync --progress -avze "ssh -p 22" $SPHINXBASE/sphinx-out/blender_python_reference_$BLENDER_VERSION.pdf $SSH_HOST:$SSH_UPLOAD_FULL/blender_python_reference_$BLENDER_VERSION.pdf
fi
if $DO_OUT_HTML_ZIP ; then
rsync --progress -avze "ssh -p 22" $SPHINXBASE/blender_python_reference_$BLENDER_VERSION.zip $SSH_HOST:$SSH_UPLOAD_FULL/blender_python_reference_$BLENDER_VERSION.zip
fi
move wiki api intro and overview docs into the api reference docs. Updated docs since some parts still were from beta still.
2011-08-25 04:25:33 +00:00
fi
# ----------------------------------------------------------------------------
# Print some useful text
echo ""
echo "Finished! view the docs from: "
- include enum names and descriptions in sphinx generated documentation - add descriptions for operator bl_options
2011-09-15 16:15:24 +00:00
if $DO_OUT_HTML ; then echo " html:" $SPHINXBASE/sphinx-out/contents.html ; fi
if $DO_OUT_PDF ; then echo " pdf:" $SPHINXBASE/sphinx-out/blender_python_reference_$BLENDER_VERSION.pdf ; fi
Reference in New Issue Copy Permalink