add docs landing page to sphinx project

Author: james

docs/codeql/_templates/layout.html

@@ -46,7 +46,7 @@
                     d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z">
                 </path>
             </svg>
-            <span class="hide-sm">{{ project }}</span>
+            <span class="hide-sm">CodeQL documentation</span>
         </a>
     </div>
     <div class="Header-item hide-sm hide-md">

docs/codeql/conf.py

@@ -1,29 +1,20 @@
 # -*- coding: utf-8 -*-
 #
-# Global configuration file, created on 29th April 2019.
-#
-# The config values below are used across all of the sphinx projects
+# The Sphinx config values used in the CodeQL documentation that is published
+# at codeql.github.com/docs
 # 
 # Note that not all possible configuration values are present in this file.
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
-
+#
 # For details of all possible config values, 
 # see https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-##################################################################################
-#
-# Project-specific values are configured in the relevant conf.py file. 
-# See individual projects for details 
 #
-##################################################################################
-
-# -- GLOBAL GENERAL CONFIG VALUES ------------------------------------------------
+# -- GENERAL CONFIG VALUES ------------------------------------------------
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
-# source_suffix = ['.rst', '.md']
 source_suffix = '.rst'
 
 # The master toctree document.
@@ -42,10 +33,6 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-
 # The encoding of source files.
 source_encoding = 'utf-8-sig'
 
@@ -61,10 +48,9 @@ def setup(sphinx):
     from qllexer import QLLexer
     sphinx.add_lexer("ql", QLLexer())
 
-# The Semmle version info for the current release you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
+# The version of CodeQL for the current release you're documenting, acts as replacement for
+# |version| and |release|
+
 # The short X.Y version.
 version = u'3.0'
 # The full version, including alpha/beta/rc tags.
@@ -85,13 +71,11 @@ def setup(sphinx):
 
 # -- Global HTML configuration -------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
+# The theme to use for HTML pages. See  https://github.com/bitprophet/alabaster/blob/master/alabaster/static/alabaster.css_t
+# Many of the built-in theme styles are overridden by the static stylesheets in html_static_path.
 html_theme = 'alabaster'
 
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
+# HTML theme options used to customize the look and feel of the docs.
 html_theme_options = {'font_size': '16px',
                       'body_text': '#333', 
                       'link': '#2F1695',
@@ -101,13 +85,14 @@ def setup(sphinx):
                       'head_font_family': '-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"',
                       }
 
-# Add any paths that contain templates here, relative to this directory.
+# Path to the folder that contains the project's HTML template
 templates_path = ['_templates']
 
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
+# Path to the folder that contains static stylesheets
 html_static_path = ['_static']
 
-exclude_patterns = ['vale*', '_static', '_templates', 'reusables', 'images', 'support', 'ql-training', 'query-help','_build', '*.py*', 'README.rst']
-##############################################################################
+# Copy the static landing page for codeql.github.com/docs when building this sphinx project
+html_extra_path = ['index.html']
+
+# Exclude these paths from being built by Sphinx
+exclude_patterns = ['vale*', '_static', '_templates', 'reusables', 'images', 'support', 'ql-training', 'query-help', '_build', '*.py*', 'README.rst']