diff --git a/.github/workflows/push-docs.yml b/.github/workflows/push-docs.yml new file mode 100644 index 0000000000..3ba3e6a710 --- /dev/null +++ b/.github/workflows/push-docs.yml @@ -0,0 +1,29 @@ +name: "Push scaladoc on gh-pages" + +on: + push: + branches: + - dev + release: + types: + - published + +jobs: + push-docs: + runs-on: ubuntu-latest + timeout-minutes: 30 + + steps: + - uses: actions/checkout@v2 + with: + submodules: 'recursive' + - uses: ./.github/actions + + - name: Build scaladoc + run: sbt clean compile unidoc + + - name: Deploy 🚀 + uses: JamesIves/github-pages-deploy-action@v4 + with: + folder: target/scala-2.12/unidoc + target-folder: ${{ github.ref_name }} diff --git a/.github/workflows/scala.yml b/.github/workflows/scala.yml index be54f48868..42b4df36e4 100644 --- a/.github/workflows/scala.yml +++ b/.github/workflows/scala.yml @@ -20,7 +20,7 @@ jobs: - name: Run tests run: sbt "++2.11.12; testWithoutFormal" - + formal: runs-on: ubuntu-latest timeout-minutes: 90 @@ -30,8 +30,20 @@ jobs: with: submodules: 'recursive' - uses: ./.github/actions - + ############################################## - + - name: Run tests run: sbt "++2.11.12; testFormal" + + scaladoc: + runs-on: ubuntu-latest + timeout-minutes: 30 + + steps: + - uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Build scaladoc + run: sbt unidoc diff --git a/build.sbt b/build.sbt index fa942c43a3..8bbece4b09 100644 --- a/build.sbt +++ b/build.sbt @@ -7,7 +7,7 @@ val defaultSettings = Defaults.coreDefaultSettings ++ xerial.sbt.Sonatype.sonaty organization := "com.github.spinalhdl", version := SpinalVersion.all, crossScalaVersions := SpinalVersion.compilers, - scalaVersion := SpinalVersion.compilers(0), + scalaVersion := SpinalVersion.compilers(1), scalacOptions ++= Seq("-unchecked","-target:jvm-1.8"/*, "-feature" ,"-deprecation"*/), javacOptions ++= Seq("-source", "1.8", "-target", "1.8"), fork := true, @@ -72,7 +72,7 @@ lazy val all = (project in file(".")) version := SpinalVersion.all, publishArtifact := false, publishLocal := {}, - ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(lib, core) + ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(lib, core, sim) ) .aggregate(sim, idslpayload, idslplugin, core, lib, debugger, tester) @@ -208,16 +208,3 @@ addCommandAlias("testFormal", "testOnly * -- -n spinal.tester.formal") addCommandAlias("testWithoutFormal", "testOnly * -- -l spinal.tester.formal") assembly / assemblyOutputPath := file("./release/spinalhdl.jar") - -//To publish the scala doc : -//rm -rf ghpages -//sbt clean compile unidoc -//git clone https://github.com/SpinalHDL/SpinalHDL.git -b gh-pages --depth=1 ghpages -//rm -rf ghpages/* -//cp -r target/scala-2.11/unidoc/* ghpages -//cd ghpages -//git add * -//git commit -m "publish doc" -//git push -//cd .. -//rm -rf ghpages diff --git a/core/src/main/scala/spinal/core/core.scala b/core/src/main/scala/spinal/core/core.scala index 73e87fb8b6..0ba7666136 100644 --- a/core/src/main/scala/spinal/core/core.scala +++ b/core/src/main/scala/spinal/core/core.scala @@ -252,10 +252,9 @@ package object core extends BaseTypeFactory with BaseTypeCast { implicit def BigIntToBits(that: BigInt): Bits = B(that) - /** - * Literal builder S/U/B"[[size']base]value” + /** Literal builder {{{ S/U/B"[[size']base]value" }}} * - * e.g. : B"8'xFF" + * e.g.: {{{ B"8'xFF"` }}} */ implicit class LiteralBuilder(private val sc: StringContext) { @@ -562,4 +561,4 @@ package object core extends BaseTypeFactory with BaseTypeCast { object LITTLE extends Endianness /** Big-Endian */ object BIG extends Endianness -} \ No newline at end of file +} diff --git a/project/plugin.sbt b/project/plugin.sbt index cabd21fba7..971f3d255d 100644 --- a/project/plugin.sbt +++ b/project/plugin.sbt @@ -2,7 +2,7 @@ addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "2.3") addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.1.0") -addSbtPlugin("com.eed3si9n" % "sbt-unidoc" % "0.4.1") +addSbtPlugin("com.github.sbt" % "sbt-unidoc" % "0.5.0") addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.14.10")