Skip to content
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

Merged
merged 2 commits into from
Jul 5, 2018
Merged

Update documentation #101

merged 2 commits into from
Jul 5, 2018

Conversation

kornilova203
Copy link
Member

@kornilova203 kornilova203 commented Jul 4, 2018

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

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/"
Copy link
Member Author

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" to version := "0.2"
  • generate docs
  • release
  • manually change version := "0.2" to version := "0.3-SNAPSHOT"

Is there a way to automate this?

Document bindgen options
@kornilova203
Copy link
Member Author

I found out that it is also possible to push generated docs to gh-pages branch

@kornilova203 kornilova203 changed the title [WIP] Use Paradox for documentation Update documentation Jul 4, 2018
@kornilova203 kornilova203 force-pushed the documentation branch 3 times, most recently from 4b310ea to 4b0ea18 Compare July 4, 2018 18:23
@kornilova203
Copy link
Member Author

Documentation can be found here https://kornilova-l.github.io/scala-native-bindgen/
Currently I build and update it manually but I suppose it is possible to write travis script that will do it automatically.

@kornilova203 kornilova203 requested a review from jonas July 4, 2018 18:23
@jonas
Copy link
Member

jonas commented Jul 4, 2018

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 sbt-site with sbt-ghpages: https://www.scala-sbt.org/sbt-site/publishing.html#publishing-to-github-pages-using-sbt-ghpages

@kornilova203
Copy link
Member Author

No particular reason except that GitBook has github-like rendering, I moved back to Paradox
sbt-ghpages works 👍

Copy link
Member

@jonas jonas left a 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/
Copy link
Member

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.

@kornilova203 kornilova203 merged commit 15ded8a into master Jul 5, 2018
@kornilova203 kornilova203 deleted the documentation branch July 5, 2018 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants