mirror of
https://github.com/github/codeql.git
synced 2026-04-28 02:05:14 +02:00
CodeQL docs migration: Delete ql-spec Sphinx project
This commit is contained in:
@@ -18,8 +18,7 @@ Project structure
|
||||
The documentation currently consists of the following Sphinx projects:
|
||||
|
||||
- ``learn-ql``–help topics to help you learn CodeQL and write queries
|
||||
- ``ql-handbook``–a user-friendly guide to the QL language, which underlies CodeQL analysis
|
||||
- ``ql-spec``–formal descriptions of the QL language and QLDoc comments
|
||||
- ``ql-handbook``–an overview of important concepts in QL, the language that underlies CodeQL analysis
|
||||
- ``support``–the languages and frameworks currently supported in CodeQL analysis
|
||||
- ``ql-training``–source files for the CodeQL training and variant analysis examples slide decks
|
||||
|
||||
|
||||
@@ -1,83 +0,0 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# QL specifications build configuration file, created
|
||||
# on Weds Nov 21 2018.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated 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
|
||||
|
||||
###############################################################################
|
||||
#
|
||||
# Modified 22052019.
|
||||
|
||||
# The configuration values below are specific to the specifications
|
||||
# To amend html_theme_options, update version/release number, or add more sphinx extensions,
|
||||
# refer to code/documentation/ql-documentation/global-sphinx-files/global-conf.py
|
||||
|
||||
##############################################################################
|
||||
|
||||
# -- Project-specific configuration -----------------------------------
|
||||
|
||||
import os
|
||||
|
||||
# Import global config values
|
||||
with open(os.path.abspath("../global-sphinx-files/global-conf.py")) as in_file:
|
||||
exec(in_file.read())
|
||||
|
||||
# QLlexer doesn't cover everything included in the specs.
|
||||
# Syntax highlighting turned off until lexer has been expanded.
|
||||
highlight_language ='none'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# Project-specific information.
|
||||
project = u'QL specifications'
|
||||
|
||||
# The version info for this project, if different from version and release in main conf.py file.
|
||||
# The short X.Y version.
|
||||
#version = u'test'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
#release = u'test'
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
html_title = 'QL specifications'
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'QL specifications'
|
||||
|
||||
# -- Currently unused, but potentially useful, configs--------------------------------------
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#html_logo = None
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
#html_extra_path = []
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# exclude_patterns = []
|
||||
@@ -1,5 +0,0 @@
|
||||
README
|
||||
######
|
||||
|
||||
The specifications have moved to ``ql/docs/language/ql-handbook``.
|
||||
See https://github.com/github/semmle-docs/issues/21 for details of the restructuring.
|
||||
Reference in New Issue
Block a user