Unreal Engine Docset

A Python module defining objects to generate a Dash compatible docset from Unreal Engine documentation.

It is open source and freely available under the BSD-3-Clause terms.

Table of Contents

• 1   Features
• 2   User Guide
  • 2.1   Installation
  • 2.2   Usage
• 3   About

1   Features

The following Unreal Engine docsets are currently supported:

• C++ API
• Blueprint API
• Python API

2   User Guide

2.1   Installation

2.1.1   Poetry

The OpenColorIO Configuration for ACES repository adopts Poetry to help managing its dependencies, this is the recommended way to get started with development.

Assuming python >= 3.10 is available on your system the development dependencies are installed with Poetry as follows:

git clone https://github.com/KelSolaar/unreal-engine-docset.git
cd unreal-engine-docset
poetry install

2.2   Usage

The module expects a Unreal Engine tgz file as an input, they are typically found in the Engine/Documentation/Builds directory, e.g. Engine/Documentation/Builds/CppAPI-HTML.tgz, and an output directory:

python unreal_engine_docset.py --input "/Users/Shared/Epic Games/UE_5.3/Engine/Documentation/Builds/BlueprintAPI-HTML.tgz" --output "/Users/Shared/Epic Games/UE_5.3/Engine/Documentation/Builds"

3   About

Unreal Engine Docset by Thomas Mansencal

Copyright 2024 Thomas Mansencal – thomas.mansencal@gmail.com

This software is released under terms of BSD-3-Clause: https://opensource.org/licenses/BSD-3-Clause

https://github.com/KelSolaar/unreal-engine-docset.git