Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: show PR warning banner and fix links doc source pages #1521

Merged
merged 3 commits into from
Oct 30, 2023

Commits on Oct 30, 2023

  1. docs: show PR warning banner and fix links doc source pages

    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 bazelbuild#1516
    rickeylev committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    8f31c85 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    65a51ab View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    8632023 View commit details
    Browse the repository at this point in the history