Referenced examples in stdlib documentation page

hnaderi · Feb 18, 2023 · 96d51d1 · 96d51d1
1 parent 9357277
commit 96d51d1
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 10 deletions.
diff --git a/docs/standard-library.md b/docs/standard-library.md
@@ -63,6 +63,8 @@ def worker(con: Connection[IO]) = con.channel
   )
 ```
 
+see @:source(example.WorkPool) for a complete working example
+
 ## RPCChannel
 
 @:api(lepus.std.RPCChannel) implements an async RPC communication channel topology.
@@ -128,10 +130,10 @@ def consumer2(con: Connection[IO]) = for {
   evt <- bus.events
   _ <- eval(IO.println(s"consumer 2: $evt"))
 } yield ()
-
-
 ```
 
+see @:source(example.PubSub) for a complete working example
+
 ## Helpers
 
 ### ShortString constructors

diff --git a/example/src/main/scala/Main.scala b/example/src/main/scala/Main.scala
@@ -14,8 +14,6 @@
  * limitations under the License.
  */
 
-package com.example
-
 import cats.effect.IO
 import cats.effect.IOApp
 import com.comcast.ip4s.*

diff --git a/example/src/main/scala/PubSub.scala → example/src/main/scala/example/PubSub.scala b/example/src/main/scala/PubSub.scala → example/src/main/scala/example/PubSub.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.example
+package example
 
 import cats.effect.*
 import cats.syntax.all.*

diff --git a/example/src/main/scala/WorkPool.scala → ...ple/src/main/scala/example/WorkPool.scala b/example/src/main/scala/WorkPool.scala → ...ple/src/main/scala/example/WorkPool.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.example
+package example
 
 import cats.effect.*
 import cats.syntax.all.*

diff --git a/project/LepusSitePlugin.scala b/project/LepusSitePlugin.scala
@@ -5,6 +5,7 @@ import laika.config.LaikaKeys
 import laika.helium.Helium
 import laika.helium.config._
 import laika.rewrite.link.ApiLinks
+import laika.rewrite.link.SourceLinks
 import laika.rewrite.link.LinkConfig
 import laika.theme._
 import laika.theme.config.Color
@@ -119,11 +120,19 @@ object LepusSitePlugin extends AutoPlugin {
         .disabled
 
     },
-    laikaConfig := LaikaConfig.defaults.withConfigValue(
-      LinkConfig(apiLinks =
-        tlSiteApiUrl.value.toSeq.map(_.toString()).map(ApiLinks(_, "lepus"))
+    laikaConfig := {
+      val apiDoc = tlSiteApiUrl.value.toSeq.map(_.toString())
+      val repo = scmInfo.value.toSeq
+        .map(_.browseUrl.toString())
+        .map(url => s"$url/tree/main/example/src/main/scala/")
+
+      LaikaConfig.defaults.withConfigValue(
+        LinkConfig(
+          apiLinks = apiDoc.map(ApiLinks(_, "lepus")),
+          sourceLinks = repo.map(SourceLinks(_, "scala"))
+        )
       )
-    ),
+    },
     laikaIncludeAPI := true
   )
 }