Sphinx RNA API changelog generator.
[blender-staging.git] / doc / python_api / sphinx_doc_gen.sh
1 #!/bin/sh
2 # run from the blender source dir
3 #   bash source/blender/python/doc/sphinx_doc_gen.sh
4 # ssh upload means you need an account on the server
5
6 BLENDER="./blender.bin"
7 SSH_USER="ideasman42"
8 SSH_HOST=$SSH_USER"@emo.blender.org"
9 SSH_UPLOAD="/data/www/vhosts/www.blender.org/documentation" # blender_python_api_VERSION, added after
10
11 # 'Blender 2.53 (sub 1) Build' --> '2_53_1' as a shell script.
12 # "_".join(str(v) for v in bpy.app.version)
13 # custom blender vars
14 blender_srcdir=$(dirname $0)/../../
15 blender_version=$(grep "BLENDER_VERSION\s" $blender_srcdir/source/blender/blenkernel/BKE_blender.h | awk '{print $3}')
16 blender_version_char=$(grep BLENDER_VERSION_CHAR $blender_srcdir/source/blender/blenkernel/BKE_blender.h | awk '{print $3}')
17 blender_version_cycle=$(grep BLENDER_VERSION_CYCLE $blender_srcdir/source/blender/blenkernel/BKE_blender.h | awk '{print $3}')
18 blender_subversion=$(grep BLENDER_SUBVERSION $blender_srcdir/source/blender/blenkernel/BKE_blender.h | awk '{print $3}')
19
20 if [ "$blender_version_cycle" == "release" ]
21 then
22         BLENDER_VERSION=$(expr $blender_version / 100)_$(expr $blender_version % 100)$blender_version_char"_release"
23 else
24         BLENDER_VERSION=$(expr $blender_version / 100)_$(expr $blender_version % 100)_$blender_subversion
25 fi
26
27 SSH_UPLOAD_FULL=$SSH_UPLOAD/"blender_python_api_"$BLENDER_VERSION
28
29 SPHINXBASE=doc/python_api/
30
31 # dont delete existing docs, now partial updates are used for quick builds.
32 $BLENDER --background --factory-startup --python $SPHINXBASE/sphinx_doc_gen.py
33
34 # html
35 sphinx-build $SPHINXBASE/sphinx-in $SPHINXBASE/sphinx-out
36 cp $SPHINXBASE/sphinx-out/contents.html $SPHINXBASE/sphinx-out/index.html
37 ssh $SSH_USER@emo.blender.org 'rm -rf '$SSH_UPLOAD_FULL'/*'
38 rsync --progress -avze "ssh -p 22" $SPHINXBASE/sphinx-out/* $SSH_HOST:$SSH_UPLOAD_FULL/
39
40 # symlink the dir to a static URL
41 ssh $SSH_USER@emo.blender.org 'rm '$SSH_UPLOAD'/250PythonDoc && ln -s '$SSH_UPLOAD_FULL' '$SSH_UPLOAD'/250PythonDoc'
42
43 # pdf
44 sphinx-build -b latex $SPHINXBASE/sphinx-in $SPHINXBASE/sphinx-out
45 cd $SPHINXBASE/sphinx-out
46 make
47 cd -
48
49 # rename so local PDF has matching name.
50 mv $SPHINXBASE/sphinx-out/contents.pdf $SPHINXBASE/sphinx-out/blender_python_reference_$BLENDER_VERSION.pdf
51 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