Merge pull request #4832 from github/docs/add-favicon

adityasharad · web-flow · commit a79f1e145bf6 · 2020-12-16T13:29:32.000-08:00
[docs] Add GitHub favicon to CodeQL docs
diff --git a/docs/codeql/conf.py b/docs/codeql/conf.py
@@ -94,5 +94,7 @@ def setup(sphinx):
 # Copy the static landing page for codeql.github.com/docs when building this sphinx project
 html_extra_path = ['index.html']
 
+html_favicon = 'images/site/favicon.ico'
+
 # Exclude these paths from being built by Sphinx
 exclude_patterns = ['vale*', '_static', '_templates', 'reusables', 'images', 'support', 'ql-training', 'query-help', '_build', '*.py*', 'README.rst']
diff --git a/docs/codeql/images/site/favicon.ico b/docs/codeql/images/site/favicon.ico
diff --git a/docs/codeql/index.html b/docs/codeql/index.html
@@ -5,6 +5,7 @@
     <title>CodeQL documentation</title>
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <link rel="stylesheet" href="_static/primer.css" />
+    <link rel="shortcut icon" href="_static/favicon.ico"/>
 </head>
 
 <body>
diff --git a/docs/codeql/query-help/conf.py b/docs/codeql/query-help/conf.py
@@ -54,6 +54,8 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['../_static']
 
+html_favicon = '../images/site/favicon.ico'
+
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 
diff --git a/docs/codeql/support/conf.py b/docs/codeql/support/conf.py
@@ -71,6 +71,8 @@
                       'nosidebar':True,
                       }
 
+html_favicon = '../images/site/favicon.ico'
+
 # -- Currently unused, but potentially useful, configs--------------------------------------
 
 # Add any paths that contain custom themes here, relative to this directory.

Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,8 @@`
`71`	`71`	`'nosidebar':True,`
`72`	`72`	`}`
`73`	`73`
	`74`	`+html_favicon = '../images/site/favicon.ico'`
	`75`	`+`
`74`	`76`	`# -- Currently unused, but potentially useful, configs--------------------------------------`
`75`	`77`
`76`	`78`	`# Add any paths that contain custom themes here, relative to this directory.`