{"id":26907309,"url":"https://github.com/thindil/robodocset","last_synced_at":"2025-08-16T12:34:55.890Z","repository":{"id":108684734,"uuid":"204648953","full_name":"thindil/robodocset","owner":"thindil","description":"Generate Docsets from the ROBODoc generated documentation","archived":false,"fork":false,"pushed_at":"2020-04-02T04:58:09.000Z","size":4,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-11T11:23:44.656Z","etag":null,"topics":["docset","documentation","robodoc"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thindil.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-08-27T07:46:48.000Z","updated_at":"2020-04-02T04:58:11.000Z","dependencies_parsed_at":"2023-05-25T07:15:50.713Z","dependency_job_id":null,"html_url":"https://github.com/thindil/robodocset","commit_stats":{"total_commits":5,"total_committers":1,"mean_commits":5.0,"dds":0.0,"last_synced_commit":"788cf2762cbe045e80bd34e183a9389af3e8308b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/thindil/robodocset","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thindil%2Frobodocset","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thindil%2Frobodocset/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thindil%2Frobodocset/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thindil%2Frobodocset/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thindil","download_url":"https://codeload.github.com/thindil/robodocset/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thindil%2Frobodocset/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270709085,"owners_count":24631992,"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-08-16T02:00:11.002Z","response_time":91,"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":["docset","documentation","robodoc"],"created_at":"2025-04-01T11:55:49.973Z","updated_at":"2025-08-16T12:34:55.856Z","avatar_url":"https://github.com/thindil.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Robodocset is a simple Python script which allow to generate [Docset](https://kapeli.com/docsets)\nfrom [Robodoc](https://rfsber.home.xs4all.nl/Robo/) generated documentation.\nThis script is available under MIT license.\n\n## Setting\n\nBefore you start, you will probably need to tweak script. Open it in any editor\nand go to `types` definition. Key is part of file name to search for the\ndocumentation entries. Value is type of Docset entry which will be added to\nthe index. Thus `\"subprograms\": \"Function\"` means search the file\n*robo_subprograms.html* for documentation entries and add them as a\n*Function* type of entries. For example, if you have file *robo_enums.html* and\nyou want add entries from there as *Enum* then add to this dictionary that\nline:\n\n`\"enums\": \"Enum\"`\n\nAll supported types of documentation you can find on Docset page. \n\n## Usage\n\nThe script require to work two arguments: first argument is a name of Docset\nwhich will be generated and second is path (absolute or relative) to the\ndirectory which contains ROBODoc generated documentation. Thus, generating\nDocset from the documentation in *docs* directory and with name *SomeDoc* will\nbe looking that:\n\n`./robodocset.py SomeDoc docs`\n\n## After generation\n\nThe script of course can't generate icons for the docset. Additionally, you\nmay need to edit generated file *Info.plist* and add *docset.json* file in main\ndirectory of the generated Docset.\n\n----\n\nAnd the standard footer :)\n\nThat's all for now, and probably I forgot about something important ;) Feel\nfree to open Issue if you been have any question or problems with this script.\n\nBartek thindil Jasicki\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthindil%2Frobodocset","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthindil%2Frobodocset","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthindil%2Frobodocset/lists"}