Skip to content

Commit

Permalink
Added steps to produce scaladoc to README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
cheeseng committed Apr 6, 2021
1 parent 510d0da commit c6736ee
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,39 @@ Please use the following commands to publish to Sonatype:
```
$ sbt clean +publishSigned
```

**Creating Scaladoc**

1. Run sbt doc:

```
> sbt doc
```

2. Copy generated files in .jvm to main source:

```
> cp -r scalatestPlusScalaCheck/.jvm/target/scala-2.13/src_managed/main scalatestPlusScalaCheck/src/
```

3. Comment out source generators in build.sbt under sharedSettings and scalatestPlusScalaCheck's .jvmSettings .

4. Syntax highlight the source:

```
> cd ../highlight-scaladoc
> ant highlight-in-place -Dsrcdir=../scalatestplus-scalacheck/scalatestPlusScalaCheck/src/main
```
5. Rebuild the scaladoc::

```
> sbt scalatestPlusScalaCheckJVM/clean scalatestPlusScalaCheckJVM/doc
```

6. Copy out the scaladoc and add ads section:

```
> cp -r scalatestPlusScalaCheck/.jvm/target/scala-2.13/api ../scalatest-doc
> cd ../scalatest-doc
> ../highlight-scaladoc/scripts/add_adbutler_scalatest.sh
```

0 comments on commit c6736ee

Please sign in to comment.