{"id":19733196,"url":"https://github.com/thoughtworksinc/sbt-api-mappings","last_synced_at":"2025-04-14T01:31:04.731Z","repository":{"id":3078644,"uuid":"38890586","full_name":"ThoughtWorksInc/sbt-api-mappings","owner":"ThoughtWorksInc","description":"An Sbt plugin that fills apiMappings for common Scala libraries.","archived":false,"fork":false,"pushed_at":"2024-06-25T04:38:12.000Z","size":302,"stargazers_count":91,"open_issues_count":9,"forks_count":17,"subscribers_count":31,"default_branch":"3.0.x","last_synced_at":"2025-03-27T15:47:40.284Z","etag":null,"topics":["sbt-plugin","scaladoc"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ThoughtWorksInc.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}},"created_at":"2015-07-10T16:28:55.000Z","updated_at":"2024-12-31T07:46:45.000Z","dependencies_parsed_at":"2024-11-12T00:30:08.917Z","dependency_job_id":null,"html_url":"https://github.com/ThoughtWorksInc/sbt-api-mappings","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThoughtWorksInc%2Fsbt-api-mappings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThoughtWorksInc%2Fsbt-api-mappings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThoughtWorksInc%2Fsbt-api-mappings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThoughtWorksInc%2Fsbt-api-mappings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ThoughtWorksInc","download_url":"https://codeload.github.com/ThoughtWorksInc/sbt-api-mappings/tar.gz/refs/heads/3.0.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248807425,"owners_count":21164687,"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":["sbt-plugin","scaladoc"],"created_at":"2024-11-12T00:29:36.102Z","updated_at":"2025-04-14T01:31:04.688Z","avatar_url":"https://github.com/ThoughtWorksInc.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sbt-api-mappings\n\n[![Build Status](https://travis-ci.org/ThoughtWorksInc/sbt-api-mappings.svg?branch=master)](https://travis-ci.org/ThoughtWorksInc/sbt-api-mappings)\n\n**sbt-api-mappings** is a sbt plugin that fills `apiMappings` for common Scala libraries.\n\n## Motivation\n\nSometimes when you wrote ScalaDoc for your own classes, you may want to reference to documentation in some other libraries.\n\nFor example:\n\n``` scala\n/**\n * My own class, which works with [[scala.Option]] and [[scalaz.Monad]].\n */\nclass MyClass(optionMonad: scalaz.Monad[Option])\n```\n\nUnfortunately when running `doc` command in Sbt, you will receive a warning and the link would not be created.\n\n```\n/path/to/MyClass.scala:3: Could not find any member to link for \"scala.Option\".\n```\n\nThis plugin resolves the problem.\n\n## Usage\n\n### Step 1: Add the following lines in your `project/plugins.sbt`:\n\n``` sbt\naddSbtPlugin(\"com.thoughtworks.sbt-api-mappings\" % \"sbt-api-mappings\" % \"latest.release\")\n```\n\nNote that sbt-api-mappings 1.x requires sbt 0.13.x, sbt-api-mappings 2.x requires sbt 1.x.\n\n### Step 2: Reload the Sbt configuration:\n\n```\n\u003e reload\n```\n\n### Step 3: Generate your API documentation:\n\n```\n\u003e doc\n```\n\nNow, open the API documentation in your browser, and you will find the links to the `scala.Option` and `scalaz.Monad`'s documentation in your `MyClass` page.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthoughtworksinc%2Fsbt-api-mappings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthoughtworksinc%2Fsbt-api-mappings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthoughtworksinc%2Fsbt-api-mappings/lists"}