Skip to content

Commit

Permalink
Added current memory issue at build time to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Rubonnek committed Feb 15, 2020
1 parent f503681 commit 4ebfef0
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. 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
Expand Down

0 comments on commit 4ebfef0

Please sign in to comment.