Migrate to stardoc and regenerate documentation #213
Merged
Conversation
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
|
Specifically, the last two commits are the content of this PR, and the rest is diffbase. |
c-parsons
approved these changes
Jul 26, 2019
This was a long time coming. Our previous Skydoc workflow no longer worked, and Skydoc has been deprecated for a while. This commit updates the WORKSPACE deps for Stardoc, and rewrites the docgen workflow in docs/BUILD and update_docs.sh. Note that running the workflow requires some visibility changes to @bazel_tools, which will be in Bazel 0.29. Fixes bazel-contrib#144.
This rips out the old documentation, which was malformed and unreproducible, and adds documentation generated by Stardoc. It was generated using a development version of Bazel that makes some @bazel_tools targets publically visible. These changes will be in Bazel 0.29. Follow-up for bazel-contrib#144.
The new docgen workflow requires Bazel 0.29, which is currently unreleased. This commit excludes the docgen from being tested on CI. We'll undo this after 0.29 is released (bazel-contrib#144).
bazel-io
pushed a commit
to bazelbuild/bazel
that referenced
this pull request
Jul 29, 2019
This is needed so rules_python can run stardoc on .bzl files that depend on or mirror parts of these @bazel_tools files. See bazel-contrib/rules_python#213. RELNOTES: None PiperOrigin-RevId: 260496745
fweikert
pushed a commit
to fweikert/rules_python
that referenced
this pull request
Aug 7, 2019
* Upgrade documentation generation to Stardoc This was a long time coming. Our previous Skydoc workflow no longer worked, and Skydoc has been deprecated for a while. This commit updates the WORKSPACE deps for Stardoc, and rewrites the docgen workflow in docs/BUILD and update_docs.sh. Note that running the workflow requires some visibility changes to @bazel_tools, which will be in Bazel 0.29. Fixes bazel-contrib#144. * Regenerate documentation using Stardoc This rips out the old documentation, which was malformed and unreproducible, and adds documentation generated by Stardoc. It was generated using a development version of Bazel that makes some @bazel_tools targets publically visible. These changes will be in Bazel 0.29. Follow-up for bazel-contrib#144. * Exclude docs/ from CI config The new docgen workflow requires Bazel 0.29, which is currently unreleased. This commit excludes the docgen from being tested on CI. We'll undo this after 0.29 is released (bazel-contrib#144).
fweikert
added a commit
to bazelbuild/bazel-federation
that referenced
this pull request
Aug 13, 2019
The new version matches the current rules_python presubmit configuration from bazel-contrib/rules_python#213.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Blocked on a couple other PRs, after which I'll force-update the branch with a rebase.