Document sbt-site with Paradox #84
Conversation
Splits the heavy README file into a Paradox site with one page per generator. The main content (setup, scaladoc, preview and publish) was moved to a "Getting Started" page. Many code snippets are now derived from the scripted tests which uncovered several issues. One problem that has not been fixed in this commit is use of `requiredGems` which conflicts because it is defined in both the nanoc and the jekyll auto plugins.
|
|
||
| Each of the other generators follow a similar pattern (e.g. `JekyllPlugin.jekyllSettings(config("foo"))`). | ||
| The documentation is available at <https://sbt.github.io/sbt-site/> |
There was a problem hiding this comment.
Not sure if it would be possible to somehow (e.g. from Travis) publish it under http://www.scala-sbt.org/sbt-site/ similar to http://www.scala-sbt.org/sbt-native-packager/ ?
There was a problem hiding this comment.
http://www.scala-sbt.org/sbt-pgp/ also does it.
I'm not sure how, but I don't think it would be difficult to do on Travis CI.
@muuki88 Do you know how you publish your docs to http://www.scala-sbt.org/sbt-native-packager/ ?
There was a problem hiding this comment.
I haven't configured it, but I'm sure it's done with Github pages custom domains.
@jsuereth is the single source of truth I guess 😎
There was a problem hiding this comment.
Thanks, then it must be the CNAME file in the sbt.github.com repo which does the magic and the sbt-site repo just needs to add/enable the gh-pages branch similar to sbt-native-packager.
| siteSubdirName in Jekyll := "notJekyllButHyde" | ||
| //#siteSubdirName | ||
|
|
||
| /* FIXME: This currently fails |
Splits the heavy README file into a Paradox site with one page per
generator. The main content (setup, scaladoc, preview and publish) was
moved to a "Getting Started" page.
Many code snippets are now derived from the scripted tests which
uncovered several issues. One problem that has not been fixed in this
commit is use of
requiredGemswhich conflicts because it is defined inboth the nanoc and the jekyll auto plugins.
It can be seen here: https://jonas.github.io/sbt-site/index.html