Skip to content

Commit

Permalink
Guide to wipe the build/environment
Browse files Browse the repository at this point in the history
  • Loading branch information
humitos committed Dec 20, 2017
1 parent ec16058 commit 8d447ec
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/guides/wipe-environment.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Wiping a Build/Environment
==========================

Sometimes it happen that your Builds start failing because the
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,
for example.

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 files
associated with it will be removed but not the documentation
itself.

Now you can re-build the version with a fresh environment!

0 comments on commit 8d447ec

Please sign in to comment.