From 0fb9b7e4bb9676f18cbda92cfd6ed836ac551f5f Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Tue, 5 Dec 2017 16:00:26 -0800 Subject: [PATCH] Suggest wiping your environment to folks with bad build outcomes. (#3347) Suggest wiping your environment to folks with bad build outcomes. This is a basic start to trying to be more helpful to users. --- .../builds/static/builds/css/detail.css | 4 +++ readthedocs/core/views/__init__.py | 2 +- .../templates/builds/build_detail.html | 23 ++++++++++++++++ readthedocs/templates/wipe_version.html | 26 ++++++++++++++++--- 4 files changed, 51 insertions(+), 4 deletions(-) diff --git a/readthedocs/builds/static/builds/css/detail.css b/readthedocs/builds/static/builds/css/detail.css index 53442c7f767..9c62b21e294 100644 --- a/readthedocs/builds/static/builds/css/detail.css +++ b/readthedocs/builds/static/builds/css/detail.css @@ -35,6 +35,10 @@ div.build-detail div.build-state > span.build-state-successful { background: #5a5; } +div.build-detail div.build-ideas { + padding: .5em; +} + ul.build-meta { display: block; width: 40%; diff --git a/readthedocs/core/views/__init__.py b/readthedocs/core/views/__init__.py index a8125eff0ee..0a54aa733ee 100644 --- a/readthedocs/core/views/__init__.py +++ b/readthedocs/core/views/__init__.py @@ -98,7 +98,7 @@ def wipe_version(request, project_slug, version_slug): for del_dir in del_dirs: broadcast(type='build', task=remove_dir, args=[del_dir]) return redirect('project_version_list', project_slug) - return render_to_response('wipe_version.html', + return render_to_response('wipe_version.html', {'version': version, 'project': version.project}, context_instance=RequestContext(request)) diff --git a/readthedocs/templates/builds/build_detail.html b/readthedocs/templates/builds/build_detail.html index 18023416b0a..856d6e70533 100644 --- a/readthedocs/templates/builds/build_detail.html +++ b/readthedocs/templates/builds/build_detail.html @@ -92,6 +92,29 @@ +
+ {% if not build.success and build.commands.count < 4 %} +

+ + {% url 'wipe_version' build.version.project.slug build.version.slug as wipe_url %} + {% blocktrans %} + Having trouble with your build environment? + Try reseting it. + {% endblocktrans %} +

+ {% endif %} + + {% if not build.success and "setup.py install" in build.commands.last.output %} +

+ {% url 'projects_advanced' build.version.project.slug as advanced_url %} + {% blocktrans %} + Don't want

setup.py install
called? + Change the Install Project setting in your advanced settings. + {% endblocktrans %} +

+ {% endif %} +
+ {% if build.output %} {# If we have build output, this is an old build #}

diff --git a/readthedocs/templates/wipe_version.html b/readthedocs/templates/wipe_version.html index 1483125f39c..e11235cc7b2 100644 --- a/readthedocs/templates/wipe_version.html +++ b/readthedocs/templates/wipe_version.html @@ -1,16 +1,36 @@ {% extends "base.html" %} +{% load i18n %} + +{% block project_editing %} + {% with versions_active="active" %} + {% include "core/project_bar.html" %} + {% endwith %} +{% endblock %} + {% block title %}Wipe the build directories for a version {% endblock %} {% block content %} +

+{% blocktrans with slug=version.slug %} + Remove build environment for {{ slug }} version. +{% endblocktrans %} +

+ {% if deleted %} -Your project environment has been wiped.

+

+ {% blocktrans %} + Your project environment has been wiped. + {% endblocktrans %} +

{% else %} -Having trouble getting your documentation build to complete? By clicking on the button below you'll clean out your build checkouts and environment, but not your generated documentation. + {% blocktrans %} + Having trouble getting your documentation build to complete? By clicking on the button below you'll clean out your build checkouts and environment, but not your generated documentation. + {% endblocktrans %}
- +
{% endif %}