{"id":26907308,"url":"https://github.com/thindil/roboada","last_synced_at":"2026-05-01T09:32:03.400Z","repository":{"id":108684704,"uuid":"184544943","full_name":"thindil/roboada","owner":"thindil","description":"Add Robodoc templates to Ada code","archived":false,"fork":false,"pushed_at":"2020-08-18T07:41:02.000Z","size":23,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-01T11:55:44.356Z","etag":null,"topics":["ada","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-05-02T08:16:31.000Z","updated_at":"2020-08-18T07:41:04.000Z","dependencies_parsed_at":"2023-05-04T03:31:59.447Z","dependency_job_id":null,"html_url":"https://github.com/thindil/roboada","commit_stats":{"total_commits":35,"total_committers":1,"mean_commits":35.0,"dds":0.0,"last_synced_commit":"a1b5e6e0664d5d18d668bebd4884e17b5c6f1591"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/thindil/roboada","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thindil%2Froboada","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thindil%2Froboada/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thindil%2Froboada/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thindil%2Froboada/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thindil","download_url":"https://codeload.github.com/thindil/roboada/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thindil%2Froboada/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32492148,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"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":["ada","robodoc"],"created_at":"2025-04-01T11:55:49.972Z","updated_at":"2026-05-01T09:32:03.379Z","avatar_url":"https://github.com/thindil.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## General information\n\nRoboAda is the bundle of small Python scripts which helps create RoboDoc\ndocumentation from Ada code. At this moment here are available two scritps:\n\n## Roboada.py\n\nRoboAda its short for *Add ROBODoc templates to Ada code*. It is very simple,\nugly and not optimized script to add ROBODoc documentation to Ada specification\nfiles (.ads) based on existing comments in them. It support comments written\nabove and below code. This files are part of other, ultra-hyper-secret project\n:)\n\n### Usage\n\nThis file will convert Ada code files (*.ads* and *.adb*) from this same\ndirectory where this script is. Modified files will be placed in subdirectory\n*result* in this same directory. Thus to use it, put it to directory with your\ncode (or copy your code to directory where scrip is) and type:\n\n* If you want to document only *.ads* files: `./roboada.py`\n* If you want to document only *.adb* files: `./roboada.py internal`\n* If you want to document all Ada source (*.ads* and *.adb*):\n  `./roboada.py all`\n\n## Generatedocs.py\n\nROBODoc have problems with Ada attributes: it is visible when option\n`--syntaxcolors` is used. To fix this problem, you can use this script. It fix\nall attributes in generated HTML files.\n\n### Usage\n\nFirst, it generate documentation with selected ROBODoc configuration file and\nthen, it scan selected directory (and its subdirectories) for HTML files and\nif it find inside them incorrect Ada attribute, the script will replace it\nwith valid HTML code and replace old HTML file with new. It can take two\noptional arguments: first is path (absolute or relative) to the configuration\nfile for ROBODoc, second is the path (absolute or relative) to the directory\nto scan.\n\n* `./generatedocs.py` will generate documentation by using file\n**robodocada.rc** from this same directory and then it will scan current\ndirectory (and its subdirectories) for HTML files and correct them if needed.\n* `./generatedocs.py others/robodocada.rc` will generate documentation by using\nthe ROBODoc configuration file **others/robodocada.rc** and then it will scan\ncurrent directory (and its subdirectories) for HTML files and correct them\nif needed.\n* `./generatedocs.py others/robodocada.rc docs` will generate documentation\nby using the ROBODoc configuration file **others/robodocada.rc** and then it\nwill scan subdirectory *docs* (and its subdirectories) of current directory for\nHTML files and correct them.\n\n## Generatedocs.tcl\n\nIt is Tcl version of above script. It can be a bit better than Python version.\nIt usage is exactly that same like Python version.\n\n## Robodocada.rc\n\nTo create ROBODoc documentation from Ada sources, you must use as a ROBODoc\nconfiguration file *robodocada.rc*. Thus, after creating documented code with\n**roboada.py**, to create documentation with many files type: `robodoc\n--src result --doc docs --multidoc --rc robodocada.rc`.\n\n## License\n\nFiles **roboada.py**, **generatedocs.py**, **generatedocs.tcl** are distributed\nunder MIT license.\n\nFile **robodocada.rc** is in public domain.\n\n## Others\n\nI strongly recommend to read [ROBODoc documentation](https://rfsber.home.xs4all.nl/Robo/pages/robodoc-49942-user-manual.html).\nEspecially if you want to extend this script.\n\n----\n\nAnd standard footer :)\n\nThat's all for now, and probably I forgot about something important ;)\n\nBartek thindil Jasicki\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthindil%2Froboada","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthindil%2Froboada","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthindil%2Froboada/lists"}