-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation #101
Update documentation #101
Conversation
48ee348
to
861fde2
Compare
build.sbt
Outdated
.settings( | ||
paradoxTheme := Some(builtinParadoxTheme("generic")), | ||
paradoxProperties in Compile ++= Map( | ||
"github.base_url" -> "https://github.com/kornilova-l/scala-native-bindgen/tree/master/" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be something like s"https://github.com/kornilova-l/scala-native-bindgen/tree/v${version.value}"
But what will be the way to release new version then?
- manually change
version := "0.2-SNAPSHOT"
toversion := "0.2"
- generate docs
- release
- manually change
version := "0.2"
toversion := "0.3-SNAPSHOT"
Is there a way to automate this?
Document bindgen options
861fde2
to
a55e696
Compare
I found out that it is also possible to push generated docs to |
4b310ea
to
4b0ea18
Compare
Documentation can be found here https://kornilova-l.github.io/scala-native-bindgen/ |
What was the reason to switch from Paradox to GitBook? Was it problem with configuration or something else? I personally think Paradox is a better fit since it has better indexing capabilities and because GitBook seems to have gone closed source. For publishing we can use |
No particular reason except that GitBook has github-like rendering, I moved back to Paradox |
4b0ea18
to
4ab3361
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome work with the tutorial.
.gitignore
Outdated
@@ -1,3 +1,4 @@ | |||
target/ | |||
scripts/.coursier | |||
scripts/.scalafmt-* | |||
/docs/_book/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is no longer needed.
4ab3361
to
f9b771b
Compare
What will be a proper way to deploy documentation?
One option is to use github pages but pushing generated htmls and other files to the repo does not look good to me.
Closes #96