{"id":13726249,"url":"https://github.com/rescript-association/doc-tools","last_synced_at":"2025-05-07T21:31:48.358Z","repository":{"id":114563525,"uuid":"244842067","full_name":"rescript-association/doc-tools","owner":"rescript-association","description":"A toolset for Reason / OCaml related documentation generation","archived":false,"fork":false,"pushed_at":"2020-04-09T12:09:48.000Z","size":80,"stargazers_count":14,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-08-04T01:28:41.596Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"OCaml","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/rescript-association.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}},"created_at":"2020-03-04T08:06:19.000Z","updated_at":"2021-08-15T09:21:06.000Z","dependencies_parsed_at":"2023-05-10T23:00:45.298Z","dependency_job_id":null,"html_url":"https://github.com/rescript-association/doc-tools","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rescript-association%2Fdoc-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rescript-association%2Fdoc-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rescript-association%2Fdoc-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rescript-association%2Fdoc-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rescript-association","download_url":"https://codeload.github.com/rescript-association/doc-tools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224654180,"owners_count":17347685,"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":[],"created_at":"2024-08-03T01:02:56.850Z","updated_at":"2024-11-14T16:33:32.207Z","avatar_url":"https://github.com/rescript-association.png","language":"OCaml","funding_links":[],"categories":["OCaml"],"sub_categories":[],"readme":"# doc-tools\n\nA toolset for Reason / OCaml related documentation generation\n\n\n## Requirements\n\n1. Clone [Bucklescript](https://github.com/BuckleScript/bucklescript) somewhere on your machine (for example at `~/projects/bucklescript`).\n2. Follow the build instructions in [`CONTRIBUTING.md`](https://github.com/BuckleScript/bucklescript/blob/master/CONTRIBUTING.md) in the Bucklescript repository.\n3. Install [esy](https://esy.sh) with `npm install -g esy`.\n\n\n## Generate documentation from Bucklescript modules\n\nMake sure you followed all the steps in the Requirements section first. Once that is done, you can build the `bs-doc` tool (this is a temporary name).\n\n```\n$ esy\n```\n\nAnd finally, run the tool to generate the documentation artefacts (_e.g._ JSON):\n\n```\n$ esy x -- bs-doc --output=_output --bs-project-dir=~/projects/bucklescript\n```\n\nThis will generate JSON and odoc files in the `_output` folder. When regenerating the files, make sure to remove the previously created files.\n\nFor additional configuration options see:\n\n```\n$ esy x -- bs-doc --help\n```\n\n\n## Working on JSON generator\n\nCurrently the JSON generation is implemented in a [forked version of odoc](https://github.com/odis-labs/odoc).\n\nTo work with the JSON generator, clone the forked version of odoc on your machine and build it with esy `esy @ocaml-4.06`.\n\nTo use the modified version of odoc, you can update the `package.json` file in this repository to link to the cloned `odoc` folder.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frescript-association%2Fdoc-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frescript-association%2Fdoc-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frescript-association%2Fdoc-tools/lists"}