{"id":13726327,"url":"https://github.com/ocaml/odoc","last_synced_at":"2025-05-15T18:09:41.093Z","repository":{"id":37430949,"uuid":"61213211","full_name":"ocaml/odoc","owner":"ocaml","description":"Documentation compiler for OCaml and Reason","archived":false,"fork":false,"pushed_at":"2025-03-18T11:24:49.000Z","size":133911,"stargazers_count":330,"open_issues_count":106,"forks_count":99,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-04-07T23:11:16.767Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"OCaml","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ocaml.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-06-15T14:10:32.000Z","updated_at":"2025-03-28T13:43:03.000Z","dependencies_parsed_at":"2023-09-27T13:26:57.561Z","dependency_job_id":"7aaa6d77-03cf-4ef0-8c8d-93d45e226b00","html_url":"https://github.com/ocaml/odoc","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ocaml%2Fodoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ocaml%2Fodoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ocaml%2Fodoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ocaml%2Fodoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ocaml","download_url":"https://codeload.github.com/ocaml/odoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254394722,"owners_count":22063984,"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:59.452Z","updated_at":"2025-05-15T18:09:41.071Z","avatar_url":"https://github.com/ocaml.png","language":"OCaml","funding_links":[],"categories":["OCaml"],"sub_categories":[],"readme":"# **[odoc](https://ocaml.github.io/odoc/) : OCaml Documentation Generator**\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://ocaml.ci.dev/github/ocaml/odoc\"\u003e\n    \u003cimg src=\"https://img.shields.io/endpoint?url=https%3A%2F%2Fci.ocamllabs.io%2Fbadge%2Focaml%2Fodoc%2Fmaster\u0026logo=ocaml\" alt=\"OCaml-CI Build Status\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://coveralls.io/github/ocaml/odoc\"\u003e\n    \u003cimg src=\"https://coveralls.io/repos/github/ocaml/odoc/badge.svg\" alt=\"Coverage Status\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n**`odoc`** is a powerful and flexible documentation generator for OCaml. It reads *doc comments*, demarcated by `(** ... *)`, and transforms them into a variety of output formats, including HTML, LaTeX, and man pages.\n\n- **Output Formats:** `odoc` generates HTML for web browsing, LaTeX for PDF generation, and man pages for use on Unix-like systems.\n- **Cross-References:** `odoc` uses the `ocamldoc` markup, which allows users to create links for functions, types, modules, and documentation pages.\n- **Link to Source Code:** Documentation generated includes links to the source code of functions, providing an easy way to navigate from the docs to the actual implementation.\n- **Code Highlighting:** `odoc` automatically highlights syntax in code snippets for different languages.\n\n`odoc` is part of the [OCaml Platform](https://ocaml.org/docs/platform), the recommended set of tools for OCaml.\n\n## Getting Started\n\nTo begin using `odoc`, first install it using opam with the following command:\n\n```\n$ opam install odoc\n```\n\nOnce installed, you can generate your project documentation with [Dune](https://github.com/ocaml/dune):\n\n```\n$ dune build @doc\n```\n\nUpon completion, you'll find your freshly minted docs in `_build/default/_doc/_html/index.html`:\n\n```\n$ open _build/default/_doc/_html/index.html\n```\n\nFor more in-depth information and usage instructions, see the [`odoc` website](https://ocaml.github.io/odoc).\n\n## Documentation\n\nThe full documentation for `odoc`, including comprehensive user and API guides, can be found on our [website](https://ocaml.github.io/odoc/).\n\n## Contributing\n\n### [Contributing Guide](CONTRIBUTING.md)\n\nWe wholeheartedly welcome contributors! To start, please read our [Contributing Guide](CONTRIBUTING.md) to familiarise yourself with our development process, including how to propose and how to start hacking on `odoc`.\n\n### [Code of Conduct][coc]\n\nIn order to foster a welcoming and respectful community, `odoc` has adopted the [OCaml Code of Conduct](coc).\n\n[coc]: https://ocaml.org/policies/code-of-conduct\n\n### [Roadmap](ROADMAP.md)\n\nInterested in the future of `odoc`? Take a look at our [Roadmap](ROADMAP.md) to understand our vision and planned advancements for `odoc`.\n\n### [Discussions][discussions]\n\nFor conversations on ongoing development, be sure to visit the [odoc][discussions] section of the OCaml Discuss forum.\n\n[discussions]: https://discuss.ocaml.org/tag/odoc\n\n## License\n\n`odoc` is distributed under the terms of the ISC License. See the [LICENSE](LICENSE) file for complete details.\n\n## Acknowledgments\n\n`odoc` owes its existence to the efforts of [Thomas Refis](https://github.com/trefis), [Leo White](https://github.com/lpw25), and [David Sheets](https://github.com/dsheets). The project was initiated in 2014 and 2015.\n\nWe'd also like to extend our appreciation to [Anton Bachin](https://github.com/aantron), [Daniel Bünzli](https://github.com/dbuenzli), and [Jon Ludlam](https://github.com/jonludlam) for their pivotal contributions to `odoc`.\n\nFurthermore, we express our gratitude to [Jane Street](https://www.janestreet.com/) and [Tarides](https://tarides.com/), whose funding has been critical to support the ongoing development of `odoc`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Focaml%2Fodoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Focaml%2Fodoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Focaml%2Fodoc/lists"}