Move documentation to Paradox (#50) #51
Conversation
| @@ -47,7 +47,8 @@ sbt '+publishSigned' | |||
|
|
|||
| echo "Publishing docs..." | |||
| sbt makeSite | |||
| mv documentation/target/sphinx/html ../releasing-the-docs | |||
| rm -rf documentation/target/paradox/paradox # Paradox site bug? | |||
There was a problem hiding this comment.
This is a workaround for what might be a bug in the sbt-site Paradox plugin. If I have time I will try to investigate later.
There was a problem hiding this comment.
Best to report on paradox repo I think. Issue is that it should have cleaned up that directory by itself right?
There was a problem hiding this comment.
I opened sbt/sbt-site#80
|
Wohoo, awesome :) |
|
LGTM, lookin good. |
... and fix the snippet markers.
Paradox uses it as the doc site title.
They are provided by Paradox out of the box.
Only the search page exists, but not yet supported in Paradox.
Method anchors do not use parenthesis anymore.
Laika does not parse that properly.
They are not checked by Paradox.
Reverts changes done to .rst files in commit 83d0858.
|
Did one last pass |
|
|
||
| ``` | ||
| curl https://financialcryptography.com # uses cacert.org as a CA | ||
| ``` |
There was a problem hiding this comment.
Syntax highlighting thinks that // is a start of a comment. Can we adjust that by giving a hint after ```?
There was a problem hiding this comment.
I marked this as sh to fix in jonas/ssl-config@f650944
| not match the domain name in the URL). | ||
| If you'd like to turn off curl's verification of the certificate, use | ||
| the -k (or --insecure) option. | ||
| ``` |
There was a problem hiding this comment.
Here as well text after ' is highlighted differently.
There was a problem hiding this comment.
I've opened lightbend/paradox#64 to fix this
|
|
||
| Play comes with `play.api.test.WsTestClient`, which provides two | ||
| methods, `wsCall` and `wsUrl`. It can be helpful to use | ||
| `PlaySpecification` and `in new WithApplication` |
There was a problem hiding this comment.
Paradox comes with quite a convenient way of linking to external scaladoc. It would be nice to go throught this doc and add the links to external APIs.
Created a ticket for it #52
There was a problem hiding this comment.
Agree, right now I don't think the scaladocs are published.
There was a problem hiding this comment.
Looks great to me. Thanks @jonas for putting the resulting HTML to a GitHub pages. This really makes it so easier to review and give meaningful comments.
I have thought about but not figured out completely how to build and host the docs somewhere for every PR during review. So you (or any other contributor) do not have to do it manually.
Some CI services provide build artifact archiving for PRs, but I was unable to find anything that suited HTML pages.
|
I don't know what limitations GitHub puts on their pages, but one idea would be to have a separate |
|
What's missing here to make this happen; the release process I guess? // @2m |
|
I think we can merge this one. The release process can be adjusted in a separate PR. |
|
Boom, thanks |
|
Kudos guys for migrating this! |
The result can be viewed here: https://jonas.github.io/ssl-config/index.html
Fixes #50