[Bf-blender-cvs] [95cba371903] master: Py Doc: Delete old deployment scripts
Aaron Carlisle
noreply at git.blender.org
Fri Feb 12 19:17:06 CET 2021
Commit: 95cba371903febe2f39a3c86eca264e0a688cd52
Author: Aaron Carlisle
Date: Fri Feb 12 13:00:22 2021 -0500
Branches: master
https://developer.blender.org/rB95cba371903febe2f39a3c86eca264e0a688cd52
Py Doc: Delete old deployment scripts
Now, the API docs are deployed via the new devops pipeline developed by
James.
===================================================================
D doc/python_api/sphinx_doc_gen.sh
D doc/python_api/sphinx_doc_update.py
===================================================================
diff --git a/doc/python_api/sphinx_doc_gen.sh b/doc/python_api/sphinx_doc_gen.sh
deleted file mode 100755
index 26c3701f3e0..00000000000
--- a/doc/python_api/sphinx_doc_gen.sh
+++ /dev/null
@@ -1,156 +0,0 @@
-#!/bin/sh
-# run from the blender source dir
-# bash doc/python_api/sphinx_doc_gen.sh
-# ssh upload means you need an account on the server
-
-# ----------------------------------------------------------------------------
-# Upload vars
-
-# disable for testing
-DO_UPLOAD=true
-DO_EXE_BLENDER=true
-DO_OUT_HTML=true
-DO_OUT_HTML_ZIP=true
-DO_OUT_PDF=false
-
-if [ -z $BLENDER_BIN ] ; then
- BLENDER_BIN="./blender.bin"
-fi
-
-if [ "$1" == "" ] ; then
- echo "Expected a single argument for the username on blender.org, skipping upload step!"
- DO_UPLOAD=false
-else
- SSH_USER=$1
- SSH_HOST=$SSH_USER"@blender.org"
- SSH_UPLOAD="/data/www/vhosts/www.blender.org/api" # blender_python_api_VERSION, added after
-fi
-
-
-# ----------------------------------------------------------------------------
-# Blender Version & Info
-
-# 'Blender 2.53 (sub 1) Build' --> '2_53_1' as a shell script.
-# "_".join(str(v) for v in bpy.app.version)
-# custom blender vars
-blender_srcdir=$(dirname -- $0)/../..
-blender_version_header="$blender_srcdir/source/blender/blenkernel/BKE_blender_version.h"
-blender_version=$(grep "BLENDER_VERSION\s" "$blender_version_header" | awk '{print $3}')
-blender_version_cycle=$(grep "BLENDER_VERSION_CYCLE\s" "$blender_version_header" | awk '{print $3}')
-unset blender_version_header
-
-BLENDER_VERSION=$(expr $blender_version / 100)_$(expr $blender_version % 100)
-
-SSH_UPLOAD_FULL=$SSH_UPLOAD/"blender_python_api_"$BLENDER_VERSION
-
-SPHINXBASE=doc/python_api
-
-SPHINX_WORKDIR="$(mktemp --directory --suffix=.sphinx)"
-
-
-# ----------------------------------------------------------------------------
-# Generate reStructuredText (blender/python only)
-
-if $DO_EXE_BLENDER ; then
- # Don't delete existing docs, now partial updates are used for quick builds.
- #
- # Disable ASAN error halt since it results in nonzero exit code on any minor issue.
- ASAN_OPTIONS=halt_on_error=0:${ASAN_OPTIONS} \
- $BLENDER_BIN \
- --background \
- -noaudio \
- --factory-startup \
- --python-exit-code 1 \
- --python $SPHINXBASE/sphinx_doc_gen.py \
- -- \
- --output=$SPHINX_WORKDIR
-
-
- if (($? != 0)) ; then
- echo "Generating documentation failed, aborting"
- exit 1
- fi
-fi
-
-# ----------------------------------------------------------------------------
-# Generate HTML (sphinx)
-
-if $DO_OUT_HTML ; then
- sphinx-build -b html -j auto $SPHINX_WORKDIR/sphinx-in $SPHINX_WORKDIR/sphinx-out
-
- # 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
-
- # in case we have a zip already
- rm -f blender_python_reference_$BLENDER_VERSION.zip
-
- # ------------------------------------------------------------------------
- # 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
-
- cd -
-fi
-
-
-# ----------------------------------------------------------------------------
-# Generate PDF (sphinx/laytex)
-
-if $DO_OUT_PDF ; then
- sphinx-build -n -b latex -j auto $SPHINX_WORKDIR/sphinx-in $SPHINX_WORKDIR/sphinx-out
- make -C $SPHINX_WORKDIR/sphinx-out
- mv $SPHINX_WORKDIR/sphinx-out/contents.pdf \
- $SPHINX_WORKDIR/sphinx-out/blender_python_reference_$BLENDER_VERSION.pdf
-fi
-
-# ----------------------------------------------------------------------------
-# Upload to blender servers, comment this section for testing
-
-if $DO_UPLOAD ; then
-
- ssh $SSH_USER at blender.org 'rm -rf '$SSH_UPLOAD_FULL'/*'
- rsync --progress -ave "ssh -p 22" $SPHINX_WORKDIR/sphinx-out/* $SSH_HOST:$SSH_UPLOAD_FULL/
-
- ## symlink the dir to a static URL
- #ssh $SSH_USER at blender.org 'rm '$SSH_UPLOAD'/250PythonDoc && ln -s '$SSH_UPLOAD_FULL' '$SSH_UPLOAD'/250PythonDoc'
- if [ "$blender_version_cycle" = "release" ] ; then
- ssh $SSH_USER at blender.org 'rm '$SSH_UPLOAD'/blender_python_api_current && ln -s '$SSH_UPLOAD_FULL' '$SSH_UPLOAD'/blender_python_api_current'
- fi
-
- # better redirect
- ssh $SSH_USER at 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'
-
- # redirect for release only so wiki can point here
- if [ "$blender_version_cycle" = "release" ] ; then
- ssh $SSH_USER at 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'/blender_python_api/index.html'
- fi
-
- if $DO_OUT_PDF ; then
- # rename so local PDF has matching name.
- rsync --progress -ave "ssh -p 22" \
- $SPHINX_WORKDIR/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 -ave "ssh -p 22" \
- $SPHINX_WORKDIR/blender_python_reference_$BLENDER_VERSION.zip \
- $SSH_HOST:$SSH_UPLOAD_FULL/blender_python_reference_$BLENDER_VERSION.zip
- fi
-
-fi
-
-
-# ----------------------------------------------------------------------------
-# Print some useful text
-
-echo ""
-echo "Finished! view the docs from: "
-if $DO_OUT_HTML ; then echo " html:" $SPHINX_WORKDIR/sphinx-out/index.html ; fi
-if $DO_OUT_PDF ; then echo " pdf:" $SPHINX_WORKDIR/sphinx-out/blender_python_reference_$BLENDER_VERSION.pdf ; fi
diff --git a/doc/python_api/sphinx_doc_update.py b/doc/python_api/sphinx_doc_update.py
deleted file mode 100755
index 71b49d4949d..00000000000
--- a/doc/python_api/sphinx_doc_update.py
+++ /dev/null
@@ -1,216 +0,0 @@
-#!/usr/bin/env python3
-
-# ##### BEGIN GPL LICENSE BLOCK #####
-#
-# This program is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License
-# as published by the Free Software Foundation; either version 2
-# of the License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software Foundation,
-# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-#
-# ##### END GPL LICENSE BLOCK #####
-
-# <pep8 compliant>
-
-"""
-This is a helper script to generate Blender Python API documentation (using Sphinx), and update server data using rsync.
-
-You'll need to specify your user login and password, obviously.
-
-Example usage:
-
- ./sphinx_doc_update.py --jobs 16 --mirror ../../../docs/remote_api_backup/ --source ../.. --blender ../../../build_cmake/bin/blender --user foobar --password barfoo
-
-"""
-
-import os
-import shutil
-import subprocess
-import sys
-import tempfile
-import zipfile
-
-
-DEFAULT_RSYNC_SERVER = "docs.blender.org"
-DEFAULT_RSYNC_ROOT = "/api/"
-DEFAULT_SYMLINK_ROOT = "/data/www/vhosts/docs.blender.org/api"
-
-
-def argparse_create():
- import argparse
- global __doc__
-
- # When --help or no args are given, print this help
- usage_text = __doc__
-
- parser = argparse.ArgumentParser(description=usage_text,
- formatter_class=argparse.RawDescriptionHelpFormatter)
-
- parser.add_argument(
- "--mirror", dest="mirror_dir",
- metavar='PATH', required=True,
- help="Path to local rsync mirror of api doc server")
- parser.add_argument(
- "--source", dest="source_dir",
- metavar='PATH', required=True,
- help="Path to Blender git repository")
- parser.add_argument(
- "--blender", dest="blender",
- metavar='PATH', required=True,
- help="Path to Blender executable")
- parser.add_argument(
- "--rsync-server", dest="rsync_server", default=DEFAULT_RSYNC_SERVER,
- metavar='RSYNCSERVER', type=str, required=False,
- help=("rsync server address"))
- parser.add_argument(
- "--rsync-root", dest="rsync_root", default=DEFAULT_RSYNC_ROOT,
- metavar='RSYNCROOT', type=str, required=False,
- help=("Root path of API doc on rsync server"))
- parser.add_argument(
- "--user", dest="user",
- metavar='USER', type=str, required=True,
- help=("User to login on rsync server"))
- parser.add_argument(
- "--password", dest="password",
- metavar='PASSWORD', type=str, required=True,
- help=("Password to login on rsync server"))
- parser.add_argument(
- "--jobs", dest="jobs_nr",
- metavar='NR', type=int, required=False, default=1,
- help="Number of sphinx building jobs to launch in parallel")
-
- return parser
-
-
-def main():
- # ----------
- # Parse Args
-
- args = argparse_create().parse_args()
-
- rsync_base = "rsync://%s@%s:%s" % (args.user, args.rsync_server, args.rsync_root)
-
- blenver = api_blenver = api_blenver_zip = ""
- api_name = ""
- branch = ""
- is_release = is_beta = False
-
- # I) Update local mirror using rsync.
- rsync_mirror_cmd = ("rsync", "--delete-after", "-avzz", rsync_base, args.mirror_dir)
- subprocess.run(rsync_mirror_cmd, env=dict(os.environ, RSYNC_PASSWORD=args.password))
-
- with tempfile.TemporaryDirectory() as tmp_dir:
- # II) Generate doc source in temp dir.
- doc_gen_cmd = (
- args.blender, "--background", "-noaudio", "--factory-startup", "--python-exit-code", "1",
- "--python", "%s/doc/python_api/sphinx_doc_gen.py" % args.source_dir, "--",
-
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list