@@ -227,22 +227,21 @@ def _log(self, msg):
227
227
def run (self , pk , version_pk = None , build_pk = None , record = True ,
228
228
docker = False , search = True , force = False , localmedia = True , ** __ ):
229
229
"""
230
- Run a documentation sync or sync n' build.
230
+ Run a documentation sync n' build.
231
231
232
232
This is fully wrapped in exception handling to account for a number of
233
233
failure cases. We first run a few commands in a local build environment,
234
234
but do not report on environment success. This avoids a flicker on the
235
235
build output page where the build is marked as finished in between the
236
236
local environment steps and the docker build steps.
237
237
238
- If a failure is raised, or the build is not successful, return ``False``,
239
- otherwise, ``True``.
238
+ If a failure is raised, or the build is not successful, return
239
+ ``False``, otherwise, ``True``.
240
240
241
241
Unhandled exceptions raise a generic user facing error, which directs
242
242
the user to bug us. It is therefore a benefit to have as few unhandled
243
243
errors as possible.
244
244
245
-
246
245
:param pk int: Project id
247
246
:param version_pk int: Project Version id (latest if None)
248
247
:param build_pk int: Build id (if None, commands are not recorded)
@@ -251,7 +250,9 @@ def run(self, pk, version_pk=None, build_pk=None, record=True,
251
250
:param search bool: update search
252
251
:param force bool: force Sphinx build
253
252
:param localmedia bool: update localmedia
253
+
254
254
:returns: whether build was successful or not
255
+
255
256
:rtype: bool
256
257
"""
257
258
try :
0 commit comments