From 774ba913e3979f1617e3863bee9c1cfb9c652658 Mon Sep 17 00:00:00 2001 From: "Wilson E. Alvarez" Date: Sat, 15 Feb 2020 11:14:22 -0500 Subject: [PATCH] Added current memory issue at build time to README --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 41e817e6f54..88b8daf947e 100644 --- a/README.md +++ b/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. + +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. ### Building with Sphinx on Windows