[Lldb-commits] [lldb] 2939d2e - [lldb][docs] Attempt to disable the generated GitHub button on the LLDB website

[Raphael Isemann via lldb-commits]

Author: Raphael Isemann
Date: 2021-02-01T09:47:39+01:00
New Revision: 2939d2e1b46c05432864db333ca3d5cb7ab83533

URL: https://github.com/llvm/llvm-project/commit/2939d2e1b46c05432864db333ca3d5cb7ab83533
DIFF: https://github.com/llvm/llvm-project/commit/2939d2e1b46c05432864db333ca3d5cb7ab83533.diff

LOG: [lldb][docs] Attempt to disable the generated GitHub button on the LLDB website

For unknown reasons the alabaster theme on the docs server is always generating
a GitHub link in the side bar. Beside the privacy problems of having an iframe
to some third-party service, we never configured any GitHub integration so
this button just links to the GitHub main site.

The button generation should be disabled by default, but as that's apparently
not true in the alabaster theme on the server, this patch tries working around
the issue by just explicitly turning off the GitHub integration.

Added: 
    

Modified: 
    lldb/docs/conf.py

Removed: 
    


################################################################################
diff  --git a/lldb/docs/conf.py b/lldb/docs/conf.py
index b9b94672cbde..d55aad2bcff7 100644
--- a/lldb/docs/conf.py
+++ b/lldb/docs/conf.py
@@ -130,7 +130,9 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    'font_size': '11pt'
+    'font_size': '11pt',
+    # Don't generate any links to GitHub.
+    'github_button' : 'false',
 }
 
 # Add any paths that contain custom themes here, relative to this directory.