Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add Netlify auto-publishing of
main
API docs (#116)
This branch configures Netlify to automatically build and publish the API docs for the `main` branch. This is particularly useful right now, since the console hasn't been published to `crates.io`, so we don't have docs.rs docs to refer people to yet. A deploy preview is also generated for every pull request against `main`, so we can preview the new docs added in PRs. Since I configured the Netlify docs build to deny RustDoc warnings, I also had to fix a couple broken links in the current docs. The `console` crate's docs are built with private items included. This is because the `console` application is a binary rather than a library, and will probably never be published as a lib. Those docs should be thought of as internal development docs, rather than user-facing API reference docs. Signed-off-by: Eliza Weisman <eliza@buoyant.io>
- Loading branch information
Showing
4 changed files
with
28 additions
and
6 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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,12 @@ | ||
[build] | ||
command = """ | ||
rustup install nightly --profile minimal \ | ||
&& cargo doc --no-deps --all-features -p console-subscriber -p console-api \ | ||
&& cargo doc --no-deps --all-features --document-private-items -p console | ||
""" | ||
environment = { RUSTDOCFLAGS= "--cfg docsrs -D warnings" } | ||
publish = "target/doc" | ||
|
||
[[redirects]] | ||
from = "/" | ||
to = "/console_subscriber" |