Browse Source

Added current memory issue at build time to README (#3175)

Wilson E. Alvarez 5 years ago
parent
commit
d13551a274
1 changed files with 3 additions and 0 deletions
  1. 3 0
      README.md

+ 3 - 0
README.md

@@ -64,6 +64,9 @@ make SPHINXBUILD=~/.local/bin/sphinx-build html
 ```
 ```
 
 
 The compilation might take some time as the `classes/` folder contains many files to parse.
 The compilation might take some time as the `classes/` folder contains many files to parse.
+
+In case of a `MemoryError` or `EOFError`, you can remove the `classes/` folder and run `make` again. This will drop the class references from the final HTML documentation but will keep the rest intact. Make sure to avoid using `git add .` in this case when working on a pull request, or the whole `classes/` folder will be removed when you make a commit. See [#3157](https://github.com/godotengine/godot-docs/issues/3157) for more details.
+
 You can then test the changes live by opening `_build/html/index.html` in your favorite browser.
 You can then test the changes live by opening `_build/html/index.html` in your favorite browser.
 
 
 ### Building with Sphinx on Windows
 ### Building with Sphinx on Windows