unreal-docset

unreal-docset copied to clipboard

Unreal docset generator for Dash

Docset generator for use with Dash.

Should also work with Zeal and in a regular browser (just open the generated html files inside the docset directory).

Requirements

• Go 1.13 (https://golang.org/dl/)
• UnrealEngine (http://www.unrealengine.com)

Generating the docset

• Run make
• Run ./bin/unreal-docset

The documentation will be scrapped from docs.unrealengine.com. Scrapping requires around 7GB bandwidth and around 200k http requests. Due to rate limitation the scrapping might take a while (up to an hour).

The resulting docset should be around 5GB in size.

Known issues

• Page types are not always inferred correctly.