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.

Sign up for GitHub

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

Jump to bottom

Publish Scaladocs to GitHub Pages #41

Open
joshdevins opened this issue Jan 19, 2018 · 0 comments
Open

Publish Scaladocs to GitHub Pages #41

joshdevins opened this issue Jan 19, 2018 · 0 comments
Labels
enhancement
Milestone
1.1.0

Comments

@joshdevins
Copy link
Collaborator

Along with the main README, we should ideally publish the Scaladocs in there as well. It's not immediately obvious how to use the README as the main index page and add docs so this is postponed to post-1.0.0 release.

See: https://alvinalexander.com/scala/how-to-generate-scala-documentation-scaladoc-command-examples
See: https://github.com/sbt/sbt-ghpages

Related: #9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Milestone
1.1.0
Development

No branches or pull requests
1 participant
@joshdevins