-
Notifications
You must be signed in to change notification settings - Fork 483
Generate documentation with Skydoc. #28
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| *.swp | ||
| /bazel-* |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,26 @@ | ||
| workspace(name = "io_bazel_rules_rust") | ||
|
|
||
| load("//rust:rust.bzl", "rust_repositories") | ||
|
|
||
| rust_repositories() | ||
|
|
||
| # Used for documenting Rust rules. | ||
| git_repository( | ||
| name = "io_bazel_rules_sass", | ||
| remote = "https://github.com/bazelbuild/rules_sass.git", | ||
| tag = "0.0.2", | ||
| ) | ||
|
|
||
| load("@io_bazel_rules_sass//sass:sass.bzl", "sass_repositories") | ||
|
|
||
| sass_repositories() | ||
|
|
||
| git_repository( | ||
| name = "io_bazel_skydoc", | ||
| remote = "https://github.com/bazelbuild/skydoc.git", | ||
| tag = "0.1.2", | ||
| ) | ||
|
|
||
| load("@io_bazel_skydoc//skylark:skylark.bzl", "skydoc_repositories") | ||
|
|
||
| skydoc_repositories() |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,201 @@ | ||
|
|
||
|
|
||
| <!-- | ||
| Documentation generated by Skydoc | ||
| --> | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta name="viewport" content="width=device-width initial-scale=1" /> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
|
|
||
| <title>Overview</title> | ||
|
|
||
| <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,600,700" type="text/css"> | ||
| <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons"> | ||
| <link rel="stylesheet" href="https://code.getmdl.io/1.1.1/material.green-light_blue.min.css"> | ||
| <script defer src="https://code.getmdl.io/1.1.1/material.min.js"></script> | ||
| <link rel="stylesheet" href="/main.css"> | ||
| </head> | ||
| <body> | ||
| <div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer | ||
| mdl-layout--fixed-header"> | ||
| <header class="mdl-layout__header"> | ||
| <div class="mdl-layout__header-row"> | ||
| <span class="mdl-layout-title">Overview</span> | ||
| </div> | ||
| </header> | ||
| <div class="mdl-layout__drawer"> | ||
| <span class="mdl-layout-title">Bazel</span> | ||
| <nav class="drawer-nav"> | ||
| <ul class="drawer-nav"> | ||
|
|
||
| <li><a href="/index.html">Overview</a></li> | ||
| <li> | ||
| <a href="/rust/rust.html">Rust Rules</a> | ||
| <ul> | ||
| <li><a href="/rust/rust.html#overview">Overview</a></li> | ||
| <li> | ||
| <a href="/rust/rust.html#rust_bench_test"> | ||
| rust_bench_test | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="/rust/rust.html#rust_binary"> | ||
| rust_binary | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="/rust/rust.html#rust_doc"> | ||
| rust_doc | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="/rust/rust.html#rust_doc_test"> | ||
| rust_doc_test | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="/rust/rust.html#rust_library"> | ||
| rust_library | ||
| </a> | ||
| </li> | ||
| <li> | ||
| <a href="/rust/rust.html#rust_test"> | ||
| rust_test | ||
| </a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
|
|
||
| </ul> | ||
| </nav> | ||
| </div> | ||
|
|
||
| <main class="mdl-layout__content"> | ||
| <div class="page-content"> | ||
| <h1>Overview</h1> | ||
|
|
||
|
|
||
| <nav class="toc"> | ||
| <h2>Rule sets</h2> | ||
| <ul> | ||
| <li><a href="#rust">Rust Rules</a></li> | ||
| </ul> | ||
| </nav> | ||
|
|
||
| <h2><a href="/rust/rust.html">Rust Rules</a></h2> | ||
|
|
||
| <h3>Rules</h3> | ||
| <table class="overview-table"> | ||
| <colgroup> | ||
| <col class="col-name" /> | ||
| <col class="col-description" /> | ||
| </colgroup> | ||
| <tbody> | ||
| <tr> | ||
| <td> | ||
| <a href="/rust/rust.html#rust_bench_test"> | ||
| <code>rust_bench_test</code> | ||
| </a> | ||
| </td> | ||
| <td> | ||
| <p>Builds a Rust benchmark test.</p> | ||
|
|
||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <a href="/rust/rust.html#rust_binary"> | ||
| <code>rust_binary</code> | ||
| </a> | ||
| </td> | ||
| <td> | ||
| <p>Builds a Rust binary crate.</p> | ||
|
|
||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <a href="/rust/rust.html#rust_doc"> | ||
| <code>rust_doc</code> | ||
| </a> | ||
| </td> | ||
| <td> | ||
| <p>Generates code documentation.</p> | ||
|
|
||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <a href="/rust/rust.html#rust_doc_test"> | ||
| <code>rust_doc_test</code> | ||
| </a> | ||
| </td> | ||
| <td> | ||
| <p>Runs Rust documentation tests.</p> | ||
|
|
||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <a href="/rust/rust.html#rust_library"> | ||
| <code>rust_library</code> | ||
| </a> | ||
| </td> | ||
| <td> | ||
| <p>Builds a Rust library crate.</p> | ||
|
|
||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <a href="/rust/rust.html#rust_test"> | ||
| <code>rust_test</code> | ||
| </a> | ||
| </td> | ||
| <td> | ||
| <p>Builds a Rust test crate.</p> | ||
|
|
||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| <h3>Macros</h3> | ||
| <table class="overview-table"> | ||
| <colgroup> | ||
| <col class="col-name" /> | ||
| <col class="col-description" /> | ||
| </colgroup> | ||
| <tbody> | ||
| <tr> | ||
| <td> | ||
| <a href="/rust/rust.html#rust_repositories"> | ||
| <code>rust_repositories</code> | ||
| </a> | ||
| </td> | ||
| <td> | ||
| <p>Adds the external dependencies needed for the Rust rules.</p> | ||
|
|
||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| <footer class="mdl-mini-footer"> | ||
| <div class="mdl-mini-footer__left-section"> | ||
| <div class="mdl-logo">Bazel</div> | ||
| <ul class="mdl-mini-footer__link-list"> | ||
| <li><a href="http://bazel.io">Home</a></li> | ||
| <li><a href="https://github.com/bazelbuild">GitHub</a></li> | ||
| </ul> | ||
| </div> | ||
| </footer> | ||
| </main> | ||
| </div> | ||
| </body> | ||
| </html> | ||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't that file be only on the site branch? Or maybe only have the readme checked in that redirect to the website?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can publish from a directory in the master branch now. :)
https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍