Merge pull request #3417 from rtfd/humitos/wipe/move-button

Move wipe button to version detail page

Author: ericholscher

docs/faq.rst

@@ -109,7 +109,7 @@ following settings::
 Deleting a stale or broken build environment
 --------------------------------------------
 
-If you're having trouble getting your version to build, try wiping out the existing build/environment files.  On your version list page ``/projects/[project]/versions`` there is a "Wipe" button that will remove all of the files associated with your documentation build, but not the documentation itself.
+See :doc:`guides/wipe-environment`.
 
 How do I host multiple projects on one CNAME?
 ---------------------------------------------

docs/guides/wipe-environment.rst

@@ -0,0 +1,28 @@
+Wiping a Build Environment
+==========================
+
+Sometimes it happen that your Builds start failing because the build
+environment where the documentation is created is stale or
+broken. This could happen for a couple of different reasons like `pip`
+not upgrading a package properly or a corrupted cached Python package.
+
+In any of these cases (and many others), the solution could be just
+wiping out the existing build environment files and allow Read the
+Docs to create a new fresh one.
+
+Follow these steps to wipe the build environment:
+
+* Go to **Versions**
+* Click on the **Edit** button of the version you want to wipe on the
+  right side of the page
+* Go to the bottom of the page and click the **wipe** link, next to
+  the "Save" button
+
+.. note::
+
+   By wiping the documentation build environment, all the `rst`, `md`,
+   and code files associated with it will be removed but not the
+   documentation already built (`HTML` and `PDF` files). Your
+   documentation will still online after wiping the build environment.
+
+Now you can re-build the version with a fresh build environment!

readthedocs/templates/projects/project_version_detail.html

@@ -16,8 +16,12 @@
 {% block content %}
     <h2> Editing {{ version.slug }} </h2>
     <form method="post" action=".">
-        {% csrf_token %}
-        {{ form.as_p }}
-        <input type="submit" value="Save">
+      {% csrf_token %}
+      {{ form.as_p }}
+      <p>
+        <input style="display: inline;" type="submit" value="{% trans "Save" %}">
+        {% trans "or" %}
+        <a href="{% url "wipe_version" version.project.slug version.slug %}">{% trans "wipe "%}</a>
+      </p>
     </form>
 {% endblock %}

readthedocs/templates/projects/project_version_list.html

@@ -42,7 +42,6 @@ <h1>{% trans "Active Versions" %}</h1>
 
                 {% if request.user|is_admin:project %}
                   <ul class="module-item-menu">
-                    <li><a href="{% url "wipe_version" project.slug version.slug %}">{% trans "Wipe" %}</a></li>
                     <li><a href="{% url "project_version_detail" project.slug version.slug %}">{% trans "Edit" %}</a></li>
                   </ul>
                 {% else %}
@@ -95,7 +94,6 @@ <h1>{% trans "Inactive Versions" %}</h1>
                       {% if version.built %}
                           <li><a href="{% url "project_version_delete_html" project.slug version.slug %}">{% trans "Clean" %}</a></li>
                       {% endif %}
-                      <li><a href="{% url "wipe_version" project.slug version.slug %}">{% trans "Wipe" %}</a></li>
                       <li><a href="{% url "project_version_detail" project.slug version.slug %}">{% trans "Edit" %}</a></li>
                     </ul>
                   {% endif %}