{"id":17249601,"url":"https://github.com/broadwaylamb/generate-llvm-docset","last_synced_at":"2025-07-29T17:33:48.732Z","repository":{"id":198372057,"uuid":"181744295","full_name":"broadwaylamb/generate-llvm-docset","owner":"broadwaylamb","description":"A Python 3 script for generating Dash docset for LLVM API","archived":false,"fork":false,"pushed_at":"2020-08-12T13:22:13.000Z","size":11737,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-16T06:44:38.143Z","etag":null,"topics":["cli","dash","documentation","doxygen","llvm","python3"],"latest_commit_sha":null,"homepage":"","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/broadwaylamb.png","metadata":{"files":{"readme":"README.md","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}},"created_at":"2019-04-16T18:23:26.000Z","updated_at":"2021-03-28T21:23:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"802cb5a9-4e68-4c62-b64c-5a4f7abd1680","html_url":"https://github.com/broadwaylamb/generate-llvm-docset","commit_stats":null,"previous_names":["broadwaylamb/generate-llvm-docset"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/broadwaylamb%2Fgenerate-llvm-docset","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/broadwaylamb%2Fgenerate-llvm-docset/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/broadwaylamb%2Fgenerate-llvm-docset/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/broadwaylamb%2Fgenerate-llvm-docset/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/broadwaylamb","download_url":"https://codeload.github.com/broadwaylamb/generate-llvm-docset/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228034825,"owners_count":17859221,"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","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":["cli","dash","documentation","doxygen","llvm","python3"],"created_at":"2024-10-15T06:44:47.531Z","updated_at":"2024-12-04T02:41:09.564Z","avatar_url":"https://github.com/broadwaylamb.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generate-llvm-docset\n\nA Python 3 script for generating [Dash](https://kapeli.com/dash) docset for LLVM API.\n\n![Screenshot](.github/screenshot.png)\n\n### Usage\n\nTL;DR:\n\n```\n$ git clone https://github.com/broadwaylamb/generate-llvm-docset.git\n$ cd generate-llvm-docset\n$ ./generate-llvm-docset --help\n\nusage: generate-llvm-docset.py [-h] [--clean] [--doxygen-path DOXYGEN_PATH]\n                               [--dot-path DOT_PATH]\n                               [--skip-docset-generation] [-q] [-v]\n                               llvm_version\n\npositional arguments:\n  llvm_version          LLVM version string (e. g. 8.0.0)\n\noptional arguments:\n  -h, --help            show this help message and exit\n  --clean               Download and regenerate everything from scratch\n  --doxygen-path DOXYGEN_PATH\n                        The path to doxygen executable\n  --dot-path DOT_PATH   The path to dot (from Graphviz) executable\n  --skip-docset-generation\n                        Only generate HTML documentation, without Dash .docset\n                        file\n  -q, --quiet           Suppress the output\n```\n\nCreate a directory where the generated files will be located, and run the script from there:\n\n```\n$ mkdir build\n$ ../generate-llvm-docset.py 8.0.0\nDownloading llvm-8.0.0.src.tar.xz from http://releases.llvm.org/8.0.0/llvm-8.0.0.src.tar.xz...\nExtracting llvm-8.0.0.src.tar.xz into llvm-8.0.0.src...\nConfiguring doxygen using llvm-8.0.0.src/docs/doxygen.cfg.in...\nGenerating HTML documentation (this may take some time)...\nRunning /usr/local/bin/doxygen doxygen.cfg\nCreating LLVM.docset (this may take some time)...\nRunning ../DocSetUtil/Developer/usr/bin/docsetutil index LLVM.docset\nProgress: |████████████████████████████████| 100.00%\nAdding the nice dragon icon...\nPatching Info.plist file...\nDone!\n```\n\nYou can specify any LLVM version you want.\n\n### Prerequisites\n\n- `doxygen` — can be installed via [Homebrew](http://brew.sh/): `brew install doxygen`\n- `dot` — a part of Graphviz, can also be installed via Homebrew: `brew install graphviz`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbroadwaylamb%2Fgenerate-llvm-docset","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbroadwaylamb%2Fgenerate-llvm-docset","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbroadwaylamb%2Fgenerate-llvm-docset/lists"}