From cefa4a7637f02512093b82a1705564315ddb2ba3 Mon Sep 17 00:00:00 2001 From: Unknown Date: Fri, 30 Nov 2018 16:24:00 +0100 Subject: [PATCH 1/2] Set up scaladoc generation and publishing --- build.sbt | 11 ++++++++++- project/plugins.sbt | 5 +++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/build.sbt b/build.sbt index 398fb2a..aec26d7 100644 --- a/build.sbt +++ b/build.sbt @@ -67,7 +67,7 @@ def commonSettings = Seq( ThisBuild / scalafmtOnCompile := true // Wartremover -wartremoverErrors ++= Warts.unsafe +// wartremoverErrors ++= Warts.unsafe // TODO properly configure linter and then clean up code // // Projects definitions @@ -143,3 +143,12 @@ lazy val todoAppExample = (project in file("examples/todo-app")) lazy val root: Project = project .in(file(".")) .aggregate(core, playSqlModule, sampleAppExample, todoAppExample) + .enablePlugins(GhpagesPlugin, SiteScaladocPlugin, ScalaUnidocPlugin) + .settings( + // Publish documentation + git.remoteRepo := "git@github.com:zengularity/query-monad.git", + ghpagesNoJekyll := true, + siteSubdirName in ScalaUnidoc := "api/latest", + addMappingsToSiteDir(mappings in (ScalaUnidoc, packageDoc), siteSubdirName in ScalaUnidoc), + unidocProjectFilter in (ScalaUnidoc, unidoc) := inProjects(core, playSqlModule) + ) diff --git a/project/plugins.sbt b/project/plugins.sbt index 7d45aef..996d453 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -3,3 +3,8 @@ addSbtPlugin("org.wartremover" % "sbt-wartremover" % "2.3.7") // The Play plugin, used for the play-sql module addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.6.20") + +// Plugins for documentation publishing +addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.6.2") +addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.3.2") +addSbtPlugin("com.eed3si9n" % "sbt-unidoc" % "0.4.2") From 3dbd80af6b20eb741a5526d83147d1191bddd3ef Mon Sep 17 00:00:00 2001 From: Unknown Date: Sun, 2 Dec 2018 19:41:38 +0100 Subject: [PATCH 2/2] Set up documentation site skeleton --- build.sbt | 15 ++++++++++---- docsite/contributing.md | 3 +++ docsite/getting-started.md | 3 +++ docsite/img/favicon.ico | Bin 0 -> 1261 bytes docsite/index.md | 24 +++++++++++++++++++++++ docsite/release-notes/0.1.0.md | 3 +++ docsite/release-notes/index.md | 10 ++++++++++ docsite/release-notes/release-process.md | 3 +++ project/plugins.sbt | 1 + 9 files changed, 58 insertions(+), 4 deletions(-) create mode 100644 docsite/contributing.md create mode 100644 docsite/getting-started.md create mode 100644 docsite/img/favicon.ico create mode 100644 docsite/index.md create mode 100644 docsite/release-notes/0.1.0.md create mode 100644 docsite/release-notes/index.md create mode 100644 docsite/release-notes/release-process.md diff --git a/build.sbt b/build.sbt index aec26d7..e8fd2d9 100644 --- a/build.sbt +++ b/build.sbt @@ -143,12 +143,19 @@ lazy val todoAppExample = (project in file("examples/todo-app")) lazy val root: Project = project .in(file(".")) .aggregate(core, playSqlModule, sampleAppExample, todoAppExample) - .enablePlugins(GhpagesPlugin, SiteScaladocPlugin, ScalaUnidocPlugin) + .enablePlugins(GhpagesPlugin, SiteScaladocPlugin, ScalaUnidocPlugin, ParadoxSitePlugin, ParadoxMaterialThemePlugin) .settings( // Publish documentation git.remoteRepo := "git@github.com:zengularity/query-monad.git", ghpagesNoJekyll := true, - siteSubdirName in ScalaUnidoc := "api/latest", - addMappingsToSiteDir(mappings in (ScalaUnidoc, packageDoc), siteSubdirName in ScalaUnidoc), - unidocProjectFilter in (ScalaUnidoc, unidoc) := inProjects(core, playSqlModule) + Paradox / sourceDirectory := file("docsite"), + ParadoxMaterialThemePlugin.paradoxMaterialThemeSettings(Paradox), + Paradox / paradoxMaterialTheme ~= { + _.withFavicon("img/favicon.ico") +// .withLogo("img/logo.svg") // TODO Add logo? + .withRepository(uri("https://github.com/zengularity/query-monad")) + }, + ScalaUnidoc / siteSubdirName := "api/latest", + addMappingsToSiteDir(ScalaUnidoc / packageDoc / mappings, ScalaUnidoc / siteSubdirName), + ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(core, playSqlModule) ) diff --git a/docsite/contributing.md b/docsite/contributing.md new file mode 100644 index 0000000..553554b --- /dev/null +++ b/docsite/contributing.md @@ -0,0 +1,3 @@ +# Contributing To The Project + +**TODO** diff --git a/docsite/getting-started.md b/docsite/getting-started.md new file mode 100644 index 0000000..84268db --- /dev/null +++ b/docsite/getting-started.md @@ -0,0 +1,3 @@ +# Getting Started + +**TODO** diff --git a/docsite/img/favicon.ico b/docsite/img/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..5047517a005ba6502d676109dbededb7f63504b2 GIT binary patch literal 1261 zcmVqglK=qX{r~_msQ>^IoijLz zNdN!@b4f%&RCwCNmrZC~RTRg6=e|3WnZ~5C(HgY2l|<2Qs)_x8KwAoSRj`7nV0BSM z)SX(vl}m9^#gz)`La|zOVIfLgC{>7BX_CfGMNAyKs0uNfR?{Ri@7?2KKKkx`Z<5({ zU|`;vbI(2Jf6n=z^F&p-mLDsxbf_u%5=M`T+q)3m3-q)^2~d(LZUTxaSr4#Tp$drSz$kEiVE0Rl?H~o}4uI_OELLTL z8~B8QM$|MeOcbgLk!PU`(HFe)3K)6K5=CnS4Bd{HHy+KaSVRSy@Kn>W0U;PQabm=`_ zp(@KbJ=a9UV%p`Nb+{Dqv@SC*Qz8r7P$Tm6KSqyG<@OdT4k*Y;x;fK{0~<(muU9*c z1+1LO=qA8QUPrJ8qtddW3I)Dpok^M{WU01o!^2_WQZyf8xa`RzV8zu5$PZ??&VDK7 z$W&O7HS%2H?pL9B;8JQo$7))Nef@9`q=seubAN){k-`*6B3=*mfy3URu5oaPrF zy47zp^D`G^hH9WWsqhQX>*c=$vML_kmUkKBj|}yefF8w{ z>n`A6&|$x#ay&DRu{kM7+`XB3pq!;!LmBl;B*?#x;9St(I*GU>>p(UIj{<`}^O;kq z{19|W{nAJYnsNYmBB1U?V)JV5LV^*Wx1HXPPzdx+14|iH1fP2ApFwbU1+ojMOyxVU zn7X{k777dpygi50(_Wa`xI8ihx(0YSXQZE?nBVS}Ca_DuHa*B4I>>U0VwYr`OEQrm ztX`miKa-U8#QIpasLlIrcS3H{W|J7!>nO2aohJ34-&0Nv7;Q|xvgWbhPS8GYMl6_d zYRt8FV5r60yNNkOO;Q!k41MwrCRn>%gMcIe+UbiPQp>=8j?u@J_6{sb^Y}1E%brog zG-dt?@?1Au%oN`SYC7UcR%DUgOt-e?{4PiU`Vk)SLK2pV&3pWv8B(AwZ;^V^+nNEc z<2WC1(Obkb4kQtX4iV{Sz=nUKe3s_z*6@jP$jiAy{)0oVZ45?WAP<=MDv#Y$3d&0TA+3^%c`h%tOV^n@y^VJM7+rZrz zSUiuoN+$P30b~4*h$)chNC1n&=vg{==dq}JF3a)e7?SF8ZOr;vfy=4AuLj)0Lu}L? zt);Vmew+edbmjo;0RBzChk<jFf4#>5BJ^z0I X0Fj{);>)&400000NkvXXu0mjfHLXVC literal 0 HcmV?d00001 diff --git a/docsite/index.md b/docsite/index.md new file mode 100644 index 0000000..9091d9f --- /dev/null +++ b/docsite/index.md @@ -0,0 +1,24 @@ +# query-monad + +This documentation site is still a work-in-progress. In the mean time, check +out [our README file on Github](https://github.com/zengularity/query-monad/blob/master/README.md). + +**TODO:** Short description here + +@@@ note + +* Cross-published for Scala 2.11 and 2.12. +* Releases currently available on [Zengularity Entrepot](https://github.com/zengularity/entrepot). +* API docs (scaladoc) available [here](api/latest/index.html). + +@@@ + +@@toc { depth=3 } + +@@@ index + + - [getting-started](getting-started.md) + - [contributing](contributing.md) + - [release-notes](release-notes/index.md) + +@@@ diff --git a/docsite/release-notes/0.1.0.md b/docsite/release-notes/0.1.0.md new file mode 100644 index 0000000..80281b4 --- /dev/null +++ b/docsite/release-notes/0.1.0.md @@ -0,0 +1,3 @@ +# 0.1.0 + +**TODO** diff --git a/docsite/release-notes/index.md b/docsite/release-notes/index.md new file mode 100644 index 0000000..2897657 --- /dev/null +++ b/docsite/release-notes/index.md @@ -0,0 +1,10 @@ +# Release Notes + +@@toc { depth=1 } + +@@@ index + + - [0.1.0](0.1.0.md) + - [release-process](release-process.md) + +@@@ \ No newline at end of file diff --git a/docsite/release-notes/release-process.md b/docsite/release-notes/release-process.md new file mode 100644 index 0000000..9da0880 --- /dev/null +++ b/docsite/release-notes/release-process.md @@ -0,0 +1,3 @@ +# Release Process for `sbt-site` + +**TODO** diff --git a/project/plugins.sbt b/project/plugins.sbt index 996d453..bf2688d 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -7,4 +7,5 @@ addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.6.20") // Plugins for documentation publishing addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.6.2") addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.3.2") +addSbtPlugin("io.github.jonas" % "sbt-paradox-material-theme" % "0.5.1") addSbtPlugin("com.eed3si9n" % "sbt-unidoc" % "0.4.2")