https://github.com/kelsolaar/unreal-engine-docset

Python Module to Generate a Dash Compatible Docset from Unreal Engine Documentation
https://github.com/kelsolaar/unreal-engine-docset

dash-docset python unreal-engine unreal-engine-5 zeal

Last synced: 4 months ago
JSON representation

Python Module to Generate a Dash Compatible Docset from Unreal Engine Documentation

• Host: GitHub
• URL: https://github.com/kelsolaar/unreal-engine-docset
• Owner: KelSolaar
• License: bsd-3-clause
• Created: 2024-01-17T09:41:50.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-25T18:12:56.000Z (about 1 year ago)
• Last Synced: 2024-05-02T05:04:07.711Z (9 months ago)
• Topics: dash-docset, python, unreal-engine, unreal-engine-5, zeal
• Language: Python
• Homepage: https://thomasmansencal.com
• Size: 3.18 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
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.

..  image:: https://github.com/KelSolaar/unreal-engine-docset/blob/main/docs/_static/UnrealEngineC%2B%2BAPILandingPage.png

.. contents:: **Table of Contents**

    :backlinks: none

    :depth: 2

.. sectnum::

Features

--------

The following **Unreal Engine** docsets are currently supported:

-   C++ API

-   Blueprint API

-   Python API

User Guide

----------

Installation

^^^^^^^^^^^^

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:

.. code-block:: shell

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

    cd unreal-engine-docset

    poetry install

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:

.. code-block:: shell

    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"

About

-----

| **Unreal Engine Docset** by Thomas Mansencal

| Copyright 2024 Thomas Mansencal – `[email protected] `__

| 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 `__