docs: initial doc generation using Sphinx#1489
Merged
rickeylev merged 7 commits intobazel-contrib:mainfrom Oct 17, 2023
Merged
Conversation
aignas
reviewed
Oct 13, 2023
Collaborator
aignas
left a comment
There was a problem hiding this comment.
Really interesting, thanks for sharing this!
86e4dcc to
665f882
Compare
aignas
reviewed
Oct 16, 2023
af62831 to
6aaf4ac
Compare
Collaborator
Author
|
Ok, I've cleaned this up enough to be ready for an initial review. This PR just lays the groundwork -- I'm not writing the complete porting of docs over to RTD in this PR. What I'm going to do is:
|
Collaborator
Author
Done |
938e8b2 to
6964be2
Compare
…es_python into rtd
…ild/rules_python into rtd
…bazelbuild/rules_python into rtd
…om:443/bazelbuild/rules_python into rtd
…ithub.com:443/bazelbuild/rules_python into rtd
…//ssh.github.com:443/bazelbuild/rules_python into rtd
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 lays the groundwork for using Sphinx to generate user-facing documentation and
having it published on readthedocs. It integrates with Bazel Stardoc to generate
MyST-flavored Markdown that Sphinx can process.
There are 4 basic pieces that are glued together:
sphinx_docs: This rule invokes Sphinx to generate e.g. html, latex, etcsphinx_stardoc: This rule invokes Stardoc to generate MyST-flavored Markdownthat Sphinx can process
sphinx_build_binary: This rule defines the Sphinx executable with any necessarydependencies (e.g. Sphinx extensions, like MyST) to process the docs in (1)
readthedocs_install: This rule does the necessary steps to build the docs andput them into the location the readthedocs build process expects. This is basically
just
cp -r, but its cleaner to hide it behind abazel runcommand than haveto put various shell in the readthedocs yaml config.
bzlmod and Stardoc.
Work towards #1332, #1484