-
Notifications
You must be signed in to change notification settings - Fork 81
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
Autogenerate API documentation using Skydoc #123
Comments
Skydoc does not build for me because of this bug: bazelbuild/bazel#4572. This time
I have seen this bug several times already, but wasn't sure it's not a problem in my code. But if I have Bazel working and I pull official |
Why not downgrade to 0.9? That's the version that seems to be working for
everybody.
|
I just checked, I'm actually using 0.9 from nix:
I have uninstalled system-level bazel installation (which was 0.10 actually). But still everything is the same... I'll keep trying. |
Opened an issue: bazelbuild/bazel#4612. I spent about 2 hours today (untracked, as I suppose it's some sort of issue with my setup) trying to fix this to no avail. |
Our API documentation is currently handwritten in Markdown, separate from the code. But this is error-prone. It would be better if there existed a tool to do this for us (like Haddock, doxygen, etc). Such a tool does exist, it's called Skydoc. But it's not used by many rule sets currently for some reason.
If we auto-generate docs, we should auto-deploy the generated doc on a website upon any update of the master branch.
Possibly blocked on bazelbuild/skydoc#71.
The text was updated successfully, but these errors were encountered: