search

bazelbuild / rules_scala

Scala rules for Bazel
Apache License 2.0
363 stars 275 forks source link

Skylark docs #133

Open ittaiz opened 7 years ago

ittaiz commented 7 years ago

Stumbled on to skydoc and thought it could be useful. Honestly I don't have time and I'm guessing @ianoc-stripe or @johnynek don't have either but I thought this could be an interesting task for someone wanting to learn the repository. WDYT?

johnynek commented 7 years ago

Sounds good to me. Would welcome PRs and work to publish the documentation to the GitHub site. On Wed, Feb 1, 2017 at 10:19 Ittai Zeidman notifications@github.com wrote:

Stumbled on to skydoc https://skydoc.bazel.build/ and thought it could be useful. Honestly I don't have time and I'm guessing @ianoc-stripe https://github.com/ianoc-stripe or @johnynek https://github.com/johnynek don't have either but I thought this could be an interesting task for someone wanting to learn the repository. WDYT?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/bazelbuild/rules_scala/issues/133, or mute the thread https://github.com/notifications/unsubscribe-auth/AAEJdrLFa0fXJrIjJ2saa9VBnGjCM-aZks5rYOjtgaJpZM4L0Vnx .

beala-stripe commented 5 years ago

@long-stripe and I tried this, but we hit two issues:

  1. Stardoc does not currently support generating docs for any bzl file that has a transitive dep on @bazel_tools (https://github.com/bazelbuild/skydoc/issues/166) https://github.com/bazelbuild/rules_scala/blob/725dc35d4dc05e410f093121920f8edfd0f44f9e/scala/scala.bzl#L15 https://github.com/bazelbuild/rules_scala/blob/725dc35d4dc05e410f093121920f8edfd0f44f9e/scala/scala.bzl#L494-L498
  2. Stardoc only generates markdown, and does not generate HTML. We could dump the md files to a docs/ directory, but it makes for a less nice presentation. https://github.com/bazelbuild/skydoc/issues/148