{"id":17189060,"url":"https://github.com/kelsolaar/unreal-engine-docset","last_synced_at":"2025-10-25T12:03:47.605Z","repository":{"id":218146936,"uuid":"744433366","full_name":"KelSolaar/unreal-engine-docset","owner":"KelSolaar","description":"Python Module to Generate a Dash Compatible Docset from Unreal Engine Documentation","archived":false,"fork":false,"pushed_at":"2024-01-25T18:12:56.000Z","size":3337,"stargazers_count":14,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T19:43:07.397Z","etag":null,"topics":["dash-docset","python","unreal-engine","unreal-engine-5","zeal"],"latest_commit_sha":null,"homepage":"https://thomasmansencal.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KelSolaar.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-01-17T09:41:50.000Z","updated_at":"2025-04-07T04:17:15.000Z","dependencies_parsed_at":"2024-01-20T02:29:20.180Z","dependency_job_id":"763777fb-44bc-4907-bce5-ebee82540680","html_url":"https://github.com/KelSolaar/unreal-engine-docset","commit_stats":null,"previous_names":["kelsolaar/unreal-engine-docset"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/KelSolaar/unreal-engine-docset","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KelSolaar%2Funreal-engine-docset","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KelSolaar%2Funreal-engine-docset/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KelSolaar%2Funreal-engine-docset/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KelSolaar%2Funreal-engine-docset/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KelSolaar","download_url":"https://codeload.github.com/KelSolaar/unreal-engine-docset/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KelSolaar%2Funreal-engine-docset/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280951033,"owners_count":26418954,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-25T02:00:06.499Z","response_time":81,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dash-docset","python","unreal-engine","unreal-engine-5","zeal"],"created_at":"2024-10-15T01:10:37.751Z","updated_at":"2025-10-25T12:03:47.589Z","avatar_url":"https://github.com/KelSolaar.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Unreal Engine Docset\n====================\n\nA `Python \u003chttps://www.python.org\u003e`__ module defining objects to generate a\n`Dash \u003chttps://kapeli.com/dash\u003e`__ compatible docset from\n`Unreal Engine documentation \u003chttps://docs.unrealengine.com\u003e`__.\n\nIt is open source and freely available under the\n`BSD-3-Clause \u003chttps://opensource.org/licenses/BSD-3-Clause\u003e`__ terms.\n\n..  image:: https://github.com/KelSolaar/unreal-engine-docset/blob/main/docs/_static/UnrealEngineC%2B%2BAPILandingPage.png\n\n.. contents:: **Table of Contents**\n    :backlinks: none\n    :depth: 2\n\n.. sectnum::\n\nFeatures\n--------\n\nThe following **Unreal Engine** docsets are currently supported:\n\n-   C++ API\n-   Blueprint API\n-   Python API\n\nUser Guide\n----------\n\nInstallation\n^^^^^^^^^^^^\n\nPoetry\n~~~~~~\n\nThe *OpenColorIO Configuration for ACES* repository adopts `Poetry \u003chttps://poetry.eustace.io\u003e`__\nto help managing its dependencies, this is the recommended way to get started\nwith development.\n\nAssuming `python \u003e= 3.10 \u003chttps://www.python.org/download/releases\u003e`__ is\navailable on your system the development dependencies are installed with\n`Poetry \u003chttps://poetry.eustace.io\u003e`__ as follows:\n\n.. code-block:: shell\n\n    git clone https://github.com/KelSolaar/unreal-engine-docset.git\n    cd unreal-engine-docset\n    poetry install\n\nUsage\n^^^^^\n\nThe module expects a **Unreal Engine** *tgz* file as an input, they are\ntypically found in the ``Engine/Documentation/Builds`` directory, e.g.\n``Engine/Documentation/Builds/CppAPI-HTML.tgz``, and an output directory:\n\n.. code-block:: shell\n\n    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\"\n\nAbout\n-----\n\n| **Unreal Engine Docset** by Thomas Mansencal\n| Copyright 2024 Thomas Mansencal – `thomas.mansencal@gmail.com \u003cmailto:thomas.mansencal@gmail.com\u003e`__\n| This software is released under terms of BSD-3-Clause: https://opensource.org/licenses/BSD-3-Clause\n| `https://github.com/KelSolaar/unreal-engine-docset.git \u003chttps://github.com/KelSolaar/unreal-engine-docset.git\u003e`__\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkelsolaar%2Funreal-engine-docset","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkelsolaar%2Funreal-engine-docset","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkelsolaar%2Funreal-engine-docset/lists"}