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

Skylark docs #133

Open
ittaiz opened this issue Feb 1, 2017 · 2 comments
Open

Skylark docs #133

ittaiz opened this issue Feb 1, 2017 · 2 comments

Comments

@ittaiz
Copy link
Member

ittaiz commented Feb 1, 2017

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
Copy link
Member

johnynek commented Feb 1, 2017 via email

@beala-stripe
Copy link
Contributor

@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 (Transitive dependencies on @bazel_tools make it impossible to use Stardoc skydoc#166)
    load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_file", "http_archive")

    rules_scala/scala/scala.bzl

    Lines 494 to 498 in 725dc35

    http_archive(
    name = "java_stub_template",
    sha256 = "1859a37dccaee8c56b98869bf1f22f6f5b909606aff74ddcfd59e9757a038dd5",
    urls = ["https://github.com/bazelbuild/rules_scala/archive/8b8271e3ee5709e1340b19790d0b396a0ff3dd0f.tar.gz"],
    strip_prefix = "rules_scala-8b8271e3ee5709e1340b19790d0b396a0ff3dd0f/java_stub_template",
  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. stardoc has no html output support skydoc#148

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

No branches or pull requests

3 participants