Skip to content

Commit f59f205

Browse files
committed
Guide to wipe the build/environment
1 parent 33e87e9 commit f59f205

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/guides/wipe-environment.rst

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Wiping a Build/Environment
2+
==========================
3+
4+
Sometimes it happen that your Builds start failing because the
5+
environment where the documentation is created is stale or
6+
broken. This could happen for a couple of different reasons like `pip`
7+
not upgrading a package properly or a corrupted cached Python package,
8+
for example.
9+
10+
In any of these cases (and many others), the solution could be just
11+
wiping out the existing build/environment files and allow Read the
12+
Docs to create a new fresh one.
13+
14+
Follow these steps to wipe the build/environment:
15+
16+
* Go to **Versions**
17+
* Click on the **Edit** button of the version you want to wipe on the
18+
right side of the page
19+
* Go to the bottom of the page and click the **wipe** link, next to
20+
the "Save" button
21+
22+
.. note::
23+
24+
By wiping the documentation build/environment, all the files
25+
associated with it will be removed but not the documentation
26+
itself.
27+
28+
Now you can re-build the version with a fresh environment!

0 commit comments

Comments
 (0)