Merge branch 'blender2.7'
[blender.git] / doc / python_api / sphinx_doc_update.py
1 #!/usr/bin/env python3
2
3 # ##### BEGIN GPL LICENSE BLOCK #####
4 #
5 #  This program is free software; you can redistribute it and/or
6 #  modify it under the terms of the GNU General Public License
7 #  as published by the Free Software Foundation; either version 2
8 #  of the License, or (at your option) any later version.
9 #
10 #  This program is distributed in the hope that it will be useful,
11 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
12 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 #  GNU General Public License for more details.
14 #
15 #  You should have received a copy of the GNU General Public License
16 #  along with this program; if not, write to the Free Software Foundation,
17 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 #
19 # ##### END GPL LICENSE BLOCK #####
20
21 # <pep8 compliant>
22
23 """
24 This is a helper script to generate Blender Python API documentation (using Sphinx), and update server data using rsync.
25
26 You'll need to specify your user login and password, obviously.
27
28 Example usage:
29
30    ./sphinx_doc_update.py --mirror ../../../docs/remote_api_backup/ --source ../.. --blender ../../../build_cmake/bin/blender --user foobar --password barfoo
31
32 """
33
34 import os
35 import shutil
36 import subprocess
37 import sys
38 import tempfile
39 import zipfile
40
41
42 DEFAULT_RSYNC_SERVER = "docs.blender.org"
43 DEFAULT_RSYNC_ROOT = "/api/"
44 DEFAULT_SYMLINK_ROOT = "/data/www/vhosts/docs.blender.org/api"
45
46
47 def argparse_create():
48     import argparse
49     global __doc__
50
51     # When --help or no args are given, print this help
52     usage_text = __doc__
53
54     parser = argparse.ArgumentParser(description=usage_text,
55                                      formatter_class=argparse.RawDescriptionHelpFormatter)
56
57     parser.add_argument(
58         "--mirror", dest="mirror_dir",
59         metavar='PATH', required=True,
60         help="Path to local rsync mirror of api doc server")
61     parser.add_argument(
62         "--source", dest="source_dir",
63         metavar='PATH', required=True,
64         help="Path to Blender git repository")
65     parser.add_argument(
66         "--blender", dest="blender",
67         metavar='PATH', required=True,
68         help="Path to Blender executable")
69     parser.add_argument(
70         "--rsync-server", dest="rsync_server", default=DEFAULT_RSYNC_SERVER,
71         metavar='RSYNCSERVER', type=str, required=False,
72         help=("rsync server address"))
73     parser.add_argument(
74         "--rsync-root", dest="rsync_root", default=DEFAULT_RSYNC_ROOT,
75         metavar='RSYNCROOT', type=str, required=False,
76         help=("Root path of API doc on rsync server"))
77     parser.add_argument(
78         "--user", dest="user",
79         metavar='USER', type=str, required=True,
80         help=("User to login on rsync server"))
81     parser.add_argument(
82         "--password", dest="password",
83         metavar='PASSWORD', type=str, required=True,
84         help=("Password to login on rsync server"))
85
86     return parser
87
88
89 def main():
90     # ----------
91     # Parse Args
92
93     args = argparse_create().parse_args()
94
95     rsync_base = "rsync://%s@%s:%s" % (args.user, args.rsync_server, args.rsync_root)
96
97     blenver = blenver_zip = ""
98     api_name = ""
99     branch = ""
100     is_release = False
101
102     # I) Update local mirror using rsync.
103     rsync_mirror_cmd = ("rsync", "--delete-after", "-avzz", rsync_base, args.mirror_dir)
104     subprocess.run(rsync_mirror_cmd, env=dict(os.environ, RSYNC_PASSWORD=args.password))
105
106     with tempfile.TemporaryDirectory() as tmp_dir:
107         # II) Generate doc source in temp dir.
108         doc_gen_cmd = (
109             args.blender, "--background", "-noaudio", "--factory-startup", "--python-exit-code", "1",
110             "--python", "%s/doc/python_api/sphinx_doc_gen.py" % args.source_dir, "--",
111             "--output", tmp_dir
112         )
113         subprocess.run(doc_gen_cmd)
114
115         # III) Get Blender version info.
116         getver_file = os.path.join(tmp_dir, "blendver.txt")
117         getver_script = (
118             "import sys, bpy\n"
119             "with open(sys.argv[-1], 'w') as f:\n"
120             "    is_release = bpy.app.version_cycle in {'rc', 'release'}\n"
121             "    branch = bpy.app.build_branch.split()[0].decode()\n"
122             "    f.write('%d\\n' % is_release)\n"
123             "    f.write('%s\\n' % branch)\n"
124             "    f.write('%d.%d%s\\n' % (bpy.app.version[0], bpy.app.version[1], bpy.app.version_char)\n"
125             "            if is_release else '%s\\n' % branch)\n"
126             "    f.write('%d_%d%s_release' % (bpy.app.version[0], bpy.app.version[1], bpy.app.version_char)\n"
127             "            if is_release else '%d_%d_%d' % bpy.app.version)\n"
128         )
129         get_ver_cmd = (args.blender, "--background", "-noaudio", "--factory-startup", "--python-exit-code", "1",
130                        "--python-expr", getver_script, "--", getver_file)
131         subprocess.run(get_ver_cmd)
132         with open(getver_file) as f:
133             is_release, branch, blenver, blenver_zip = f.read().split("\n")
134             is_release = bool(int(is_release))
135         os.remove(getver_file)
136
137         # IV) Build doc.
138         curr_dir = os.getcwd()
139         os.chdir(tmp_dir)
140         sphinx_cmd = ("sphinx-build", "-b", "html", "sphinx-in", "sphinx-out")
141         subprocess.run(sphinx_cmd)
142         shutil.rmtree(os.path.join("sphinx-out", ".doctrees"))
143         os.chdir(curr_dir)
144
145         # V) Cleanup existing matching dir in server mirror (if any), and copy new doc.
146         api_name = blenver
147         api_dir = os.path.join(args.mirror_dir, api_name)
148         if os.path.exists(api_dir):
149             shutil.rmtree(api_dir)
150         os.rename(os.path.join(tmp_dir, "sphinx-out"), api_dir)
151
152     # VI) Create zip archive.
153     zip_name = "blender_python_reference_%s" % blenver_zip  # We can't use 'release' postfix here...
154     zip_path = os.path.join(args.mirror_dir, zip_name)
155     with zipfile.ZipFile(zip_path, 'w') as zf:
156         for dirname, _, filenames in os.walk(api_dir):
157             for filename in filenames:
158                 filepath = os.path.join(dirname, filename)
159                 zip_filepath = os.path.join(zip_name, os.path.relpath(filepath, api_dir))
160                 zf.write(filepath, arcname=zip_filepath)
161     os.rename(zip_path, os.path.join(api_dir, "%s.zip" % zip_name))
162
163     # VII) Create symlinks and html redirects.
164     if is_release:
165         symlink = os.path.join(args.mirror_dir, "current")
166         os.remove(symlink)
167         os.symlink("./%s" % api_name, symlink)
168         with open(os.path.join(args.mirror_dir, "250PythonDoc/index.html"), 'w') as f:
169             f.write("<html><head><title>Redirecting...</title><meta http-equiv=\"REFRESH\""
170                     "content=\"0;url=../%s/\"></head><body>Redirecting...</body></html>" % api_name)
171     elif branch == "master":
172         with open(os.path.join(args.mirror_dir, "blender_python_api/index.html"), 'w') as f:
173             f.write("<html><head><title>Redirecting...</title><meta http-equiv=\"REFRESH\""
174                     "content=\"0;url=../%s/\"></head><body>Redirecting...</body></html>" % api_name)
175
176     # VIII) Upload (first do a dry-run so user can ensure everything is OK).
177     print("Doc generated in local mirror %s, please check it before uploading "
178           "(hit [Enter] to continue, [Ctrl-C] to exit):" % api_dir)
179     sys.stdin.read(1)
180
181     rsync_mirror_cmd = ("rsync", "--dry-run", "--delete-after", "-avzz", args.mirror_dir, rsync_base)
182     subprocess.run(rsync_mirror_cmd, env=dict(os.environ, RSYNC_PASSWORD=args.password))
183
184     print("Rsync upload simulated, please check every thing is OK (hit [Enter] to continue, [Ctrl-C] to exit):")
185     sys.stdin.read(1)
186
187     rsync_mirror_cmd = ("rsync", "--delete-after", "-avzz", args.mirror_dir, rsync_base)
188     subprocess.run(rsync_mirror_cmd, env=dict(os.environ, RSYNC_PASSWORD=args.password))
189
190
191 if __name__ == "__main__":
192     main()