Skip to content

Commit 2fcfefd

Browse files
Migrates from tut to mdoc (#286)
1 parent 148f672 commit 2fcfefd

File tree

5 files changed

+85
-106
lines changed

5 files changed

+85
-106
lines changed

.docs/README.md

-12
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,7 @@ We'll implement a dummy data source that can convert integers to strings. For co
7676
import cats._
7777
import cats.data.NonEmptyList
7878
import cats.effect._
79-
import cats.instances.list._
8079
import cats.implicits._
81-
import cats.syntax.all._
8280

8381
import fetch._
8482

@@ -247,8 +245,6 @@ Fetch.run[IO](fetchMulti).unsafeRunTimed(5.seconds)
247245
When fetching an identity, subsequent fetches for the same identity are cached. Let's try creating a fetch that asks for the same identity twice.
248246

249247
```scala mdoc:silent
250-
import cats.syntax.all._
251-
252248
def fetchTwice[F[_] : Concurrent]: Fetch[F, (String, String)] = for {
253249
one <- fetchString(1)
254250
two <- fetchString(1)
@@ -269,16 +265,8 @@ executor.shutdownNow()
269265

270266
For more in-depth information, take a look at our [documentation](https://47degrees.github.io/fetch/docs.html).
271267

272-
## Fetch in the wild
273-
274-
If you wish to add your library here, please consider a PR to include it in the list below.
275-
276-
[comment]: # (Start Copyright)
277-
278268
# Copyright
279269

280270
Fetch is designed and developed by 47 Degrees
281271

282272
Copyright (C) 2016-2019 47 Degrees. <http://47deg.com>
283-
284-
[comment]: # (End Copyright)

build.sbt

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import sbtcrossproject.CrossPlugin.autoImport.{crossProject, CrossType}
22

33
lazy val checkScalafmt = "+scalafmtCheck; +scalafmtSbtCheck;"
4-
lazy val checkDocs = "docs/tut;"
4+
lazy val checkDocs = "+docs/mdoc;"
55
lazy val checkJSTests = "+fetchJS/test; +debugJS/test;"
66
lazy val checkJVMTests =
77
"+coverage; +fetchJVM/test; +debugJVM/test; +examples/test; +coverageReport; +coverageAggregate;"
@@ -10,7 +10,7 @@ addCommandAlias(
1010
"ci-test",
1111
s"$checkScalafmt $checkDocs $checkJSTests $checkJVMTests"
1212
)
13-
addCommandAlias("ci-docs", "project-docs/mdoc; docs/tut; headerCreateAll")
13+
addCommandAlias("ci-docs", "project-docs/mdoc; headerCreateAll")
1414
addCommandAlias("ci-microsite", "docs/publishMicrosite")
1515

1616
lazy val root = project
@@ -48,6 +48,7 @@ lazy val docs = (project in file("docs"))
4848
.settings(docsSettings: _*)
4949
.settings(skip in publish := true)
5050
.enablePlugins(MicrositesPlugin)
51+
.enablePlugins(MdocPlugin)
5152

5253
lazy val `project-docs` = (project in file(".docs"))
5354
.aggregate(fetchJVM)

0 commit comments

Comments
 (0)