docs: show PR warning banner and fix links doc source pages#1521
Merged
rickeylev merged 3 commits intobazel-contrib:mainfrom Oct 30, 2023
Merged
docs: show PR warning banner and fix links doc source pages#1521rickeylev merged 3 commits intobazel-contrib:mainfrom
rickeylev merged 3 commits intobazel-contrib:mainfrom
Conversation
This fixes a few issues with the RTD doc building: * Warning banner is now shown for PR requests * Pages now link to the github source * The footer now shows the git commit they were built at This works by passing the RTD environment variables to the sphinx build process, which allows the conf.py file to get their values. Env vars are passed by a new flag, `--//sphinxdocs:extra_env`, which allows passing arbitrary environment variable values into the sphinx build process. To make future usage of the RTD env vars easier, the build process passes along all the `READTHEDOCS*` environment variables. Fixes bazel-contrib#1516
aignas
approved these changes
Oct 30, 2023
aignas
reviewed
Oct 30, 2023
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
2 participants
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 fixes a few issues with the RTD doc building:
This works by passing the RTD environment variables to the sphinx build process, which allows the conf.py file to get their values. Env vars are passed by a new flag,
--//sphinxdocs:extra_env, which allows passing arbitrary environment variable values into the sphinx build process. To make future usage of the RTD env vars easier, the build process passes along all theREADTHEDOCS*environment variables.Fixes #1516