{"id":27019101,"url":"https://github.com/jabbalaci/nimmultimodulelibrary","last_synced_at":"2025-10-06T13:19:19.049Z","repository":{"id":140437715,"uuid":"153815761","full_name":"jabbalaci/NimMultiModuleLibrary","owner":"jabbalaci","description":"Generate docs for a multi-module library including theindex.html. Links also work.","archived":false,"fork":false,"pushed_at":"2018-10-19T17:25:07.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-02T14:49:05.304Z","etag":null,"topics":["buildindex","doc","example","library","multi-modules","nim"],"latest_commit_sha":null,"homepage":null,"language":"Nim","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/jabbalaci.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-10-19T17:03:09.000Z","updated_at":"2018-10-19T17:25:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"01737d80-c075-4184-8d0e-3248f5ad1cde","html_url":"https://github.com/jabbalaci/NimMultiModuleLibrary","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jabbalaci/NimMultiModuleLibrary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jabbalaci%2FNimMultiModuleLibrary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jabbalaci%2FNimMultiModuleLibrary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jabbalaci%2FNimMultiModuleLibrary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jabbalaci%2FNimMultiModuleLibrary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jabbalaci","download_url":"https://codeload.github.com/jabbalaci/NimMultiModuleLibrary/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jabbalaci%2FNimMultiModuleLibrary/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278616311,"owners_count":26016346,"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-06T02:00:05.630Z","response_time":65,"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":["buildindex","doc","example","library","multi-modules","nim"],"created_at":"2025-04-04T17:19:04.320Z","updated_at":"2025-10-06T13:19:19.044Z","avatar_url":"https://github.com/jabbalaci.png","language":"Nim","funding_links":[],"categories":[],"sub_categories":[],"readme":"Generate docs for a multi-modules library\n=========================================\n\nThis is an example that shows how to create docs for\na library that contains several modules.\n\nHere we achieve the following things:\n\n* We have a library that has a main module (`src/stuff.nim`)\n  and some submodules (`src/stuff/*.nim`).\n* We generate HTML docs for every `*.nim` file.\n* We also generate an index file (`theindex.html`) that\n  contains exported things from every module.\n* The `theindex.html` file has links to every module.\n  The links work :)\n* If you click on the name of a module in `theindex.html`,\n  you get to the HTML documentation of that specific module.\n\nAs putting all these things together took me some time and I\ndidn't find a step-by-step documentation, I assembled\nthis sample project.\n\nUnder Linux, I had to execute the following commands:\n\n```bash\n$ nim doc --index:on -o:docs/htmldocs/stuff.html src/stuff.nim\n$ nim doc --index:on -o:docs/htmldocs/submodule1.html src/stuff/submodule1.nim\n$ nim doc --index:on -o:docs/htmldocs/submodule2.html src/stuff/submodule2.nim\n\n$ nim buildIndex docs/htmldocs/\n\n$ mv docs/htmldocs/*.html docs/\n\n# delete docs/htmldocs/\n\n# open docs/theindex.html\n```\n\nSee also [`03_generate_docs.sh`](03_generate_docs.sh).\n\nIt would be nice if `nim doc` could do this with a switch. Generating\na complete documentation for a multi-module library should be easy.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjabbalaci%2Fnimmultimodulelibrary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjabbalaci%2Fnimmultimodulelibrary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjabbalaci%2Fnimmultimodulelibrary/lists"}