UnrealPlugin_Documentation_RTD

The 8i Unreal Plugin is a plugin for the Unreal game engine. It adds the ability to render and interact with PAT content.

Documentation

Documentation can be found under the 'docs' folder in the root of this repository.

Writing the Docs

This documentation is written using markdown files and is generated using Sphinx.

Building The Docs

Requirements

• Python
• pip
• sphinx

Open a terminal in the root of the repo and run the following

cd docs
.\make html

The output will be located within ROOT\docs\build\html and can be hosted online or viewed offline.