Open
Conversation
bfa18f9 to
b65f21a
Compare
a4f3e53 to
ce1110c
Compare
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
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.
This switches the doc generation over to use rules_python's sphinxdocs. Sphinxdocs
is a set of rules for running Sphinx with special integrations for Starlark
doc generation and Read the Docs
Summary of changes:
{role}refsyntax instead of regular Markdown link syntax.#titles and/or replace them with{topic}. The#headers interferewith the TOC rendering.
The main benefits of this switch are:
to glue together outputs of Bazel invocations)
as first-class objects to Sphinx. These are usually generated by the Stardoc
integration, but can also be manually defined to document e.g. targets or flags.
objects and have them rendered similar to how a class is rendered in other languages.
Part of what this change does is update all the subject "classes" to render as
"typedefs".
objects being defined, cross references have a more natural, concise, and expressive
notation.
workflows (this ensures what is built locally matches what is built by RTD).