diff --git a/docs/language/.gitignore b/docs/codeql/.gitignore similarity index 100% rename from docs/language/.gitignore rename to docs/codeql/.gitignore diff --git a/docs/language/.vale.ini b/docs/codeql/.vale.ini similarity index 100% rename from docs/language/.vale.ini rename to docs/codeql/.vale.ini diff --git a/docs/language/README.rst b/docs/codeql/README.rst similarity index 79% rename from docs/language/README.rst rename to docs/codeql/README.rst index e9f17d39d3e..39c4d18cd55 100644 --- a/docs/language/README.rst +++ b/docs/codeql/README.rst @@ -5,7 +5,7 @@ Overview ******** The CodeQL documentation in this repository is written in reStructuredText and converted to -HTML for manual publication on `help.semmle.com `__ using Sphinx. +HTML using Sphinx. For more information on writing in reStructuredText, see http://docutils.sourceforge.net/rst.html. @@ -15,25 +15,21 @@ For more information on Sphinx, see https://www.sphinx-doc.org. Project structure ***************** -The documentation currently consists of the following Sphinx projects: - -- ``learn-ql``–help topics to help you learn CodeQL and write queries -- ``ql-language-reference``–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 - -Each project contains: +The project contains: - an ``index.html`` file, the project's `master document `__. - a ``conf.py`` file that defines some project-specific configuration values -- one or more reStructuredText source files +- the reStructuredText source files -Shared configuration values are specified in ``global-conf.py``, which is found -in the ``global-sphinx-files`` directory. -This directory also contains any other files, such as templates and stylesheets, -that are used by multiple projects. -Images used in the documentation are located in the ``images`` directory. +The documentation consists of the following categories: + +- CodeQL overview +- Writing CodeQL queries +- CodeQL language guides +- QL language reference +- CodeQL CLI +- CodeQL for Visual Studio Code The ``ql-training`` project contains the source files, themes, and static files used to generate the CodeQL training and variant analysis presentations. @@ -110,5 +106,5 @@ Viewing the current version of the CodeQL documentation The documentation for the most recent release is published to `help.semmle.com `__. -There, you can also find the documentation for the CodeQL CLI, -the CodeQL extension for Visual Studio Code, and LGTM Enterprise. +There, you can find the documentation for the CodeQL queries, +the CodeQL standard libraries, and LGTM Enterprise. diff --git a/docs/language/_static/custom.css_t b/docs/codeql/_static/custom.css_t similarity index 100% rename from docs/language/_static/custom.css_t rename to docs/codeql/_static/custom.css_t diff --git a/docs/language/_static/primer.css b/docs/codeql/_static/primer.css similarity index 100% rename from docs/language/_static/primer.css rename to docs/codeql/_static/primer.css diff --git a/docs/language/_templates/layout.html b/docs/codeql/_templates/layout.html similarity index 100% rename from docs/language/_templates/layout.html rename to docs/codeql/_templates/layout.html diff --git a/docs/language/codeql-cli/codeql-cli-reference/about-ql-packs.rst b/docs/codeql/codeql-cli/codeql-cli-reference/about-ql-packs.rst similarity index 100% rename from docs/language/codeql-cli/codeql-cli-reference/about-ql-packs.rst rename to docs/codeql/codeql-cli/codeql-cli-reference/about-ql-packs.rst diff --git a/docs/language/codeql-cli/codeql-cli-reference/exit-codes.rst b/docs/codeql/codeql-cli/codeql-cli-reference/exit-codes.rst similarity index 77% rename from docs/language/codeql-cli/codeql-cli-reference/exit-codes.rst rename to docs/codeql/codeql-cli/codeql-cli-reference/exit-codes.rst index f7ff0fdce0e..f313e4080d4 100644 --- a/docs/language/codeql-cli/codeql-cli-reference/exit-codes.rst +++ b/docs/codeql/codeql-cli/codeql-cli-reference/exit-codes.rst @@ -16,7 +16,7 @@ Success, normal termination. The command successfully determined that the answer to your question is "no". -This exit code is only used by a few commands, such as :doc:`codeql test run `, :doc:`codeql database check `, :doc:`codeql query format `,and :doc:`codeql resolve extractor `. +This exit code is only used by a few commands, such as `codeql test run <../codeql-cli-manual/test-run.html>`__, `codeql database check <../codeql-cli-manual/dataset-check.html>`__, `codeql query format <../codeql-cli-manual/query-format.html>`__,and `codeql resolve extractor <../codeql-cli-manual/resolve-extractor.html>`__. For more details, see the documentation for those commands. 2 @@ -37,7 +37,7 @@ In this case, the launcher can't start the Java code for the CodeQL CLI at all. 32 --- -The extractor didn't find any code to analyze when running :doc:`codeql database create ` or :doc:`codeql database finalize `. +The extractor didn't find any code to analyze when running `codeql database create <../codeql-cli-manual/database-create.html>`__ or `codeql database finalize <../codeql-cli-manual/database-finalize.html>`__. 33 --- diff --git a/docs/language/codeql-cli/codeql-cli-reference/index.rst b/docs/codeql/codeql-cli/codeql-cli-reference/index.rst similarity index 84% rename from docs/language/codeql-cli/codeql-cli-reference/index.rst rename to docs/codeql/codeql-cli/codeql-cli-reference/index.rst index 3eca66757c3..efdb0b1efa4 100644 --- a/docs/language/codeql-cli/codeql-cli-reference/index.rst +++ b/docs/codeql/codeql-cli/codeql-cli-reference/index.rst @@ -28,9 +28,8 @@ use or generate when executing CodeQL processes. .. _cli-commands: -CLI commands ------------- +CodeQL CLI commands +------------------- -The following links provide detailed information about each CodeQL CLI command, -including its usage and options. For information about the terms used in these -pages, see the ":ref:`CodeQL glossary `." +To view provide detailed information about each CodeQL CLI command, +including its usage and options, visit the "`CodeQL CLI manual <../codeql-cli-manual>`__." diff --git a/docs/language/codeql-cli/codeql-cli-reference/query-reference-files.rst b/docs/codeql/codeql-cli/codeql-cli-reference/query-reference-files.rst similarity index 100% rename from docs/language/codeql-cli/codeql-cli-reference/query-reference-files.rst rename to docs/codeql/codeql-cli/codeql-cli-reference/query-reference-files.rst diff --git a/docs/language/codeql-cli/codeql-cli-reference/sarif-output.rst b/docs/codeql/codeql-cli/codeql-cli-reference/sarif-output.rst similarity index 99% rename from docs/language/codeql-cli/codeql-cli-reference/sarif-output.rst rename to docs/codeql/codeql-cli/codeql-cli-reference/sarif-output.rst index dfb9decd202..fca88ac8f2f 100644 --- a/docs/language/codeql-cli/codeql-cli-reference/sarif-output.rst +++ b/docs/codeql/codeql-cli/codeql-cli-reference/sarif-output.rst @@ -11,7 +11,7 @@ considered "optional". This document details the output produced when using the format type ``sarifv2.1.0``, which corresponds to the SARIF v2.1.0.csd1 specification. For more information on selecting a file format for your analysis results, see -the :doc:`database analyze reference `. +the `database analyze reference <../codeql-cli-manual/database-analyze.html>`__. SARIF specification and schema ------------------------------ diff --git a/docs/language/codeql-cli/codeql-cli-reference/specifying-command-options-in-a-codeql-configuration-file.rst b/docs/codeql/codeql-cli/codeql-cli-reference/specifying-command-options-in-a-codeql-configuration-file.rst similarity index 100% rename from docs/language/codeql-cli/codeql-cli-reference/specifying-command-options-in-a-codeql-configuration-file.rst rename to docs/codeql/codeql-cli/codeql-cli-reference/specifying-command-options-in-a-codeql-configuration-file.rst diff --git a/docs/language/codeql-cli/index.rst b/docs/codeql/codeql-cli/index.rst similarity index 100% rename from docs/language/codeql-cli/index.rst rename to docs/codeql/codeql-cli/index.rst diff --git a/docs/language/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst similarity index 94% rename from docs/language/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst rename to docs/codeql/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst index ee1ac6259bd..988bc523eb8 100644 --- a/docs/language/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst @@ -26,4 +26,4 @@ command line. To run a command, use:: codeql [command] [subcommand] To view the reference documentation for a command, add the ``--help`` flag, or visit the -":ref:`CodeQL CLI reference `." \ No newline at end of file +"`CodeQL CLI manual <../codeql-cli-manual>`__." \ No newline at end of file diff --git a/docs/language/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli.rst similarity index 97% rename from docs/language/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli.rst rename to docs/codeql/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli.rst index 8e342231483..daf92ceb4bb 100644 --- a/docs/language/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli.rst @@ -48,8 +48,8 @@ You must specify: number of different formats are supported, including CSV, :ref:`SARIF `, and graph formats. For more information about CSV and SARIF, see `Results <#results>`__. To find out which other results formats are - supported, see the :doc:`database analyze reference - `. + supported, see the `database analyze reference + <../codeql-cli-manual/database-analyze.html>`__. - ``--output``: the output path of the results file generated during analysis. @@ -70,7 +70,7 @@ You can also specify: `." For full details of all the options you can use when analyzing databases, see -the :doc:`database analyze reference documentation `. +the `database analyze reference documentation <../codeql-cli-manual/database-analyze.html>`__. .. _database-analyze-examples: diff --git a/docs/language/codeql-cli/using-the-codeql-cli/creating-codeql-databases.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-databases.rst similarity index 98% rename from docs/language/codeql-cli/using-the-codeql-cli/creating-codeql-databases.rst rename to docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-databases.rst index 4edc9f8dc7e..e7248e5725f 100644 --- a/docs/language/codeql-cli/using-the-codeql-cli/creating-codeql-databases.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-databases.rst @@ -50,7 +50,7 @@ the language you want to analyze: detect the build system automatically, using a built-in autobuilder. For full details of all the options you can use when creating databases, -see the :doc:`database create reference documentation `. +see the `database create reference documentation <../codeql-cli-manual/database-create.html>`__. Progress and results -------------------- diff --git a/docs/language/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst similarity index 98% rename from docs/language/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst rename to docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst index fd799d611f7..2721dc2b115 100644 --- a/docs/language/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst @@ -233,8 +233,8 @@ instruction:: - description: -This value is displayed when you run :doc:`codeql resolve queries -`, if the suite is added to a "well-known" +This value is displayed when you run `codeql resolve queries +<../codeql-cli-manual/resolve-queries.html>`__, if the suite is added to a "well-known" directory. For more information, see "`Specifying well-known query suites <#specifying-well-known-query-suites>`__." diff --git a/docs/language/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.rst similarity index 100% rename from docs/language/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.rst rename to docs/codeql/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.rst diff --git a/docs/language/codeql-cli/using-the-codeql-cli/index.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/index.rst similarity index 100% rename from docs/language/codeql-cli/using-the-codeql-cli/index.rst rename to docs/codeql/codeql-cli/using-the-codeql-cli/index.rst diff --git a/docs/language/codeql-cli/using-the-codeql-cli/testing-custom-queries.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/testing-custom-queries.rst similarity index 99% rename from docs/language/codeql-cli/using-the-codeql-cli/testing-custom-queries.rst rename to docs/codeql/codeql-cli/using-the-codeql-cli/testing-custom-queries.rst index 4267a644202..4b561c797f3 100644 --- a/docs/language/codeql-cli/using-the-codeql-cli/testing-custom-queries.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli/testing-custom-queries.rst @@ -130,8 +130,7 @@ You can also specify: - .. include:: ../../reusables/threads-query-execution.rst For full details of all the options you can use when testing queries, -see the :doc:`test run reference documentation -`. +see the `test run reference documentation <../codeql-cli-manual/test-run.html>`__. Example ------- diff --git a/docs/language/codeql-cli/using-the-codeql-cli/testing-query-help-files.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/testing-query-help-files.rst similarity index 97% rename from docs/language/codeql-cli/using-the-codeql-cli/testing-query-help-files.rst rename to docs/codeql/codeql-cli/using-the-codeql-cli/testing-query-help-files.rst index 7df6e1e4e1c..38e154f3f38 100644 --- a/docs/language/codeql-cli/using-the-codeql-cli/testing-query-help-files.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli/testing-query-help-files.rst @@ -73,7 +73,7 @@ By default, the CodeQL CLI will print a warning message if: as an accompanying ``.qhelp`` file You can tell the CodeQL CLI how to handle these warnings by including a ``--warnings`` option in your command. -For more information, see the `generate query-help reference documentation `__. +For more information, see the `generate query-help reference documentation <../codeql-cli-manual/generate-query-help.html#cmdoption-codeql-generate-query-help-warnings>`__. Further reading --------------- diff --git a/docs/language/codeql-cli/using-the-codeql-cli/upgrading-codeql-databases.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/upgrading-codeql-databases.rst similarity index 95% rename from docs/language/codeql-cli/using-the-codeql-cli/upgrading-codeql-databases.rst rename to docs/codeql/codeql-cli/using-the-codeql-cli/upgrading-codeql-databases.rst index 850213b8d0a..922c4f5e1c5 100644 --- a/docs/language/codeql-cli/using-the-codeql-cli/upgrading-codeql-databases.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli/upgrading-codeql-databases.rst @@ -40,8 +40,7 @@ where ````, the path to the CodeQL database you want to upgrade, must be specified. For full details of all the options you can use when upgrading databases, -see the :doc:`database upgrade reference documentation -`. +see the `database upgrade reference documentation <../codeql-cli-manual/database-upgrade.html>`. Progress and results -------------------- diff --git a/docs/language/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli.rst similarity index 97% rename from docs/language/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli.rst rename to docs/codeql/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli.rst index 21fec5e19a6..b3f2d02ca1b 100644 --- a/docs/language/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli.rst @@ -7,7 +7,7 @@ You can customize your CodeQL analyses by writing your own queries to highlight specific vulnerabilities or errors. This topic is specifically about writing -queries to use with the :doc:`database analyze ` +queries to use with the `database analyze <../codeql-cli-manual/database-analyze.html>`__ command to produce :ref:`interpreted results `. .. include:: ../../reusables/advanced-query-execution.rst diff --git a/docs/language/codeql-for-visual-studio-code/.gitignore b/docs/codeql/codeql-for-visual-studio-code/.gitignore similarity index 100% rename from docs/language/codeql-for-visual-studio-code/.gitignore rename to docs/codeql/codeql-for-visual-studio-code/.gitignore diff --git a/docs/language/codeql-for-visual-studio-code/about-codeql-for-visual-studio-code.rst b/docs/codeql/codeql-for-visual-studio-code/about-codeql-for-visual-studio-code.rst similarity index 100% rename from docs/language/codeql-for-visual-studio-code/about-codeql-for-visual-studio-code.rst rename to docs/codeql/codeql-for-visual-studio-code/about-codeql-for-visual-studio-code.rst diff --git a/docs/language/codeql-for-visual-studio-code/analyzing-your-projects.rst b/docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst similarity index 98% rename from docs/language/codeql-for-visual-studio-code/analyzing-your-projects.rst rename to docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst index 31b64ec0fcd..e2baaa9443d 100644 --- a/docs/language/codeql-for-visual-studio-code/analyzing-your-projects.rst +++ b/docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst @@ -135,7 +135,7 @@ To use standard code navigation features in the source code, you can right-click If you're using an older database, code navigation commands such as **Go to Definition** and **Go to References** may not work. To use code navigation, try unzipping the database and running ``codeql database cleanup `` on the unzipped database using the CodeQL CLI. Then, re-add the database to Visual Studio Code. - For more information, see the :doc:`database cleanup ` reference documentation. + For more information, see the `database cleanup <../codeql-cli/codeql-cli-manual/database-cleanup.html>`__ reference documentation. Comparing query results ------------------------ diff --git a/docs/language/codeql-for-visual-studio-code/customizing-settings.rst b/docs/codeql/codeql-for-visual-studio-code/customizing-settings.rst similarity index 100% rename from docs/language/codeql-for-visual-studio-code/customizing-settings.rst rename to docs/codeql/codeql-for-visual-studio-code/customizing-settings.rst diff --git a/docs/language/codeql-for-visual-studio-code/exploring-data-flow-with-path-queries.rst b/docs/codeql/codeql-for-visual-studio-code/exploring-data-flow-with-path-queries.rst similarity index 100% rename from docs/language/codeql-for-visual-studio-code/exploring-data-flow-with-path-queries.rst rename to docs/codeql/codeql-for-visual-studio-code/exploring-data-flow-with-path-queries.rst diff --git a/docs/language/codeql-for-visual-studio-code/exploring-the-structure-of-your-source-code.rst b/docs/codeql/codeql-for-visual-studio-code/exploring-the-structure-of-your-source-code.rst similarity index 100% rename from docs/language/codeql-for-visual-studio-code/exploring-the-structure-of-your-source-code.rst rename to docs/codeql/codeql-for-visual-studio-code/exploring-the-structure-of-your-source-code.rst diff --git a/docs/language/codeql-for-visual-studio-code/index.rst b/docs/codeql/codeql-for-visual-studio-code/index.rst similarity index 100% rename from docs/language/codeql-for-visual-studio-code/index.rst rename to docs/codeql/codeql-for-visual-studio-code/index.rst diff --git a/docs/language/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code.rst b/docs/codeql/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code.rst similarity index 100% rename from docs/language/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code.rst rename to docs/codeql/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code.rst diff --git a/docs/language/codeql-for-visual-studio-code/testing-codeql-queries-in-visual-studio-code.rst b/docs/codeql/codeql-for-visual-studio-code/testing-codeql-queries-in-visual-studio-code.rst similarity index 100% rename from docs/language/codeql-for-visual-studio-code/testing-codeql-queries-in-visual-studio-code.rst rename to docs/codeql/codeql-for-visual-studio-code/testing-codeql-queries-in-visual-studio-code.rst diff --git a/docs/language/codeql-for-visual-studio-code/troubleshooting-codeql-for-visual-studio-code.rst b/docs/codeql/codeql-for-visual-studio-code/troubleshooting-codeql-for-visual-studio-code.rst similarity index 100% rename from docs/language/codeql-for-visual-studio-code/troubleshooting-codeql-for-visual-studio-code.rst rename to docs/codeql/codeql-for-visual-studio-code/troubleshooting-codeql-for-visual-studio-code.rst diff --git a/docs/language/codeql-language-guides/codeql-for-cpp/analyzing-data-flow-in-cpp.rst b/docs/codeql/codeql-language-guides/codeql-for-cpp/analyzing-data-flow-in-cpp.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-cpp/analyzing-data-flow-in-cpp.rst rename to docs/codeql/codeql-language-guides/codeql-for-cpp/analyzing-data-flow-in-cpp.rst diff --git a/docs/language/codeql-language-guides/codeql-for-cpp/basic-query-for-cpp-code.rst b/docs/codeql/codeql-language-guides/codeql-for-cpp/basic-query-for-cpp-code.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-cpp/basic-query-for-cpp-code.rst rename to docs/codeql/codeql-language-guides/codeql-for-cpp/basic-query-for-cpp-code.rst diff --git a/docs/language/codeql-language-guides/codeql-for-cpp/codeql-library-for-cpp.rst b/docs/codeql/codeql-language-guides/codeql-for-cpp/codeql-library-for-cpp.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-cpp/codeql-library-for-cpp.rst rename to docs/codeql/codeql-language-guides/codeql-for-cpp/codeql-library-for-cpp.rst diff --git a/docs/language/codeql-language-guides/codeql-for-cpp/conversions-and-classes-in-cpp.rst b/docs/codeql/codeql-language-guides/codeql-for-cpp/conversions-and-classes-in-cpp.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-cpp/conversions-and-classes-in-cpp.rst rename to docs/codeql/codeql-language-guides/codeql-for-cpp/conversions-and-classes-in-cpp.rst diff --git a/docs/language/codeql-language-guides/codeql-for-cpp/detecting-a-potential-buffer-overflow.rst b/docs/codeql/codeql-language-guides/codeql-for-cpp/detecting-a-potential-buffer-overflow.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-cpp/detecting-a-potential-buffer-overflow.rst rename to docs/codeql/codeql-language-guides/codeql-for-cpp/detecting-a-potential-buffer-overflow.rst diff --git a/docs/language/codeql-language-guides/codeql-for-cpp/expressions-types-and-statements-in-cpp.rst b/docs/codeql/codeql-language-guides/codeql-for-cpp/expressions-types-and-statements-in-cpp.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-cpp/expressions-types-and-statements-in-cpp.rst rename to docs/codeql/codeql-language-guides/codeql-for-cpp/expressions-types-and-statements-in-cpp.rst diff --git a/docs/language/codeql-language-guides/codeql-for-cpp/functions-in-cpp.rst b/docs/codeql/codeql-language-guides/codeql-for-cpp/functions-in-cpp.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-cpp/functions-in-cpp.rst rename to docs/codeql/codeql-language-guides/codeql-for-cpp/functions-in-cpp.rst diff --git a/docs/language/codeql-language-guides/codeql-for-cpp/hash-consing-and-value-numbering.rst b/docs/codeql/codeql-language-guides/codeql-for-cpp/hash-consing-and-value-numbering.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-cpp/hash-consing-and-value-numbering.rst rename to docs/codeql/codeql-language-guides/codeql-for-cpp/hash-consing-and-value-numbering.rst diff --git a/docs/language/codeql-language-guides/codeql-for-cpp/index.rst b/docs/codeql/codeql-language-guides/codeql-for-cpp/index.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-cpp/index.rst rename to docs/codeql/codeql-language-guides/codeql-for-cpp/index.rst diff --git a/docs/language/codeql-language-guides/codeql-for-cpp/refining-a-query-to-account-for-edge-cases.rst b/docs/codeql/codeql-language-guides/codeql-for-cpp/refining-a-query-to-account-for-edge-cases.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-cpp/refining-a-query-to-account-for-edge-cases.rst rename to docs/codeql/codeql-language-guides/codeql-for-cpp/refining-a-query-to-account-for-edge-cases.rst diff --git a/docs/language/codeql-language-guides/codeql-for-cpp/using-range-analsis-in-cpp.rst b/docs/codeql/codeql-language-guides/codeql-for-cpp/using-range-analsis-in-cpp.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-cpp/using-range-analsis-in-cpp.rst rename to docs/codeql/codeql-language-guides/codeql-for-cpp/using-range-analsis-in-cpp.rst diff --git a/docs/language/codeql-language-guides/codeql-for-cpp/using-the-guards-library-in-cpp.rst b/docs/codeql/codeql-language-guides/codeql-for-cpp/using-the-guards-library-in-cpp.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-cpp/using-the-guards-library-in-cpp.rst rename to docs/codeql/codeql-language-guides/codeql-for-cpp/using-the-guards-library-in-cpp.rst diff --git a/docs/language/codeql-language-guides/codeql-for-csharp/analyzing-data-flow-in-csharp.rst b/docs/codeql/codeql-language-guides/codeql-for-csharp/analyzing-data-flow-in-csharp.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-csharp/analyzing-data-flow-in-csharp.rst rename to docs/codeql/codeql-language-guides/codeql-for-csharp/analyzing-data-flow-in-csharp.rst diff --git a/docs/language/codeql-language-guides/codeql-for-csharp/basic-query-for-csharp-code.rst b/docs/codeql/codeql-language-guides/codeql-for-csharp/basic-query-for-csharp-code.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-csharp/basic-query-for-csharp-code.rst rename to docs/codeql/codeql-language-guides/codeql-for-csharp/basic-query-for-csharp-code.rst diff --git a/docs/language/codeql-language-guides/codeql-for-csharp/codeql-library-for-csharp.rst b/docs/codeql/codeql-language-guides/codeql-for-csharp/codeql-library-for-csharp.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-csharp/codeql-library-for-csharp.rst rename to docs/codeql/codeql-language-guides/codeql-for-csharp/codeql-library-for-csharp.rst diff --git a/docs/language/codeql-language-guides/codeql-for-csharp/index.rst b/docs/codeql/codeql-language-guides/codeql-for-csharp/index.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-csharp/index.rst rename to docs/codeql/codeql-language-guides/codeql-for-csharp/index.rst diff --git a/docs/language/codeql-language-guides/codeql-for-go/abstract-syntax-tree-classes-for-working-with-go-programs.rst b/docs/codeql/codeql-language-guides/codeql-for-go/abstract-syntax-tree-classes-for-working-with-go-programs.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/abstract-syntax-tree-classes-for-working-with-go-programs.rst rename to docs/codeql/codeql-language-guides/codeql-for-go/abstract-syntax-tree-classes-for-working-with-go-programs.rst diff --git a/docs/language/codeql-language-guides/codeql-for-go/ast.dot b/docs/codeql/codeql-language-guides/codeql-for-go/ast.dot similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/ast.dot rename to docs/codeql/codeql-language-guides/codeql-for-go/ast.dot diff --git a/docs/language/codeql-language-guides/codeql-for-go/ast.png b/docs/codeql/codeql-language-guides/codeql-for-go/ast.png similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/ast.png rename to docs/codeql/codeql-language-guides/codeql-for-go/ast.png diff --git a/docs/language/codeql-language-guides/codeql-for-go/basic-query-for-go-code.rst b/docs/codeql/codeql-language-guides/codeql-for-go/basic-query-for-go-code.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/basic-query-for-go-code.rst rename to docs/codeql/codeql-language-guides/codeql-for-go/basic-query-for-go-code.rst diff --git a/docs/language/codeql-language-guides/codeql-for-go/cfg.dot b/docs/codeql/codeql-language-guides/codeql-for-go/cfg.dot similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/cfg.dot rename to docs/codeql/codeql-language-guides/codeql-for-go/cfg.dot diff --git a/docs/language/codeql-language-guides/codeql-for-go/cfg.png b/docs/codeql/codeql-language-guides/codeql-for-go/cfg.png similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/cfg.png rename to docs/codeql/codeql-language-guides/codeql-for-go/cfg.png diff --git a/docs/language/codeql-language-guides/codeql-for-go/cfg2.dot b/docs/codeql/codeql-language-guides/codeql-for-go/cfg2.dot similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/cfg2.dot rename to docs/codeql/codeql-language-guides/codeql-for-go/cfg2.dot diff --git a/docs/language/codeql-language-guides/codeql-for-go/cfg2.png b/docs/codeql/codeql-language-guides/codeql-for-go/cfg2.png similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/cfg2.png rename to docs/codeql/codeql-language-guides/codeql-for-go/cfg2.png diff --git a/docs/language/codeql-language-guides/codeql-for-go/codeql-library-for-go.rst b/docs/codeql/codeql-language-guides/codeql-for-go/codeql-library-for-go.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/codeql-library-for-go.rst rename to docs/codeql/codeql-language-guides/codeql-for-go/codeql-library-for-go.rst diff --git a/docs/language/codeql-language-guides/codeql-for-go/dfg.dot b/docs/codeql/codeql-language-guides/codeql-for-go/dfg.dot similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/dfg.dot rename to docs/codeql/codeql-language-guides/codeql-for-go/dfg.dot diff --git a/docs/language/codeql-language-guides/codeql-for-go/dfg.png b/docs/codeql/codeql-language-guides/codeql-for-go/dfg.png similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/dfg.png rename to docs/codeql/codeql-language-guides/codeql-for-go/dfg.png diff --git a/docs/language/codeql-language-guides/codeql-for-go/index.rst b/docs/codeql/codeql-language-guides/codeql-for-go/index.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/index.rst rename to docs/codeql/codeql-language-guides/codeql-for-go/index.rst diff --git a/docs/language/codeql-language-guides/codeql-for-go/modeling-data-flow-in-go-libraries.rst b/docs/codeql/codeql-language-guides/codeql-for-go/modeling-data-flow-in-go-libraries.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/modeling-data-flow-in-go-libraries.rst rename to docs/codeql/codeql-language-guides/codeql-for-go/modeling-data-flow-in-go-libraries.rst diff --git a/docs/language/codeql-language-guides/codeql-for-go/ssa.dot b/docs/codeql/codeql-language-guides/codeql-for-go/ssa.dot similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/ssa.dot rename to docs/codeql/codeql-language-guides/codeql-for-go/ssa.dot diff --git a/docs/language/codeql-language-guides/codeql-for-go/ssa.png b/docs/codeql/codeql-language-guides/codeql-for-go/ssa.png similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-go/ssa.png rename to docs/codeql/codeql-language-guides/codeql-for-go/ssa.png diff --git a/docs/language/codeql-language-guides/codeql-for-java/abstract-syntax-tree-classes-for-working-with-java-programs.rst b/docs/codeql/codeql-language-guides/codeql-for-java/abstract-syntax-tree-classes-for-working-with-java-programs.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-java/abstract-syntax-tree-classes-for-working-with-java-programs.rst rename to docs/codeql/codeql-language-guides/codeql-for-java/abstract-syntax-tree-classes-for-working-with-java-programs.rst diff --git a/docs/language/codeql-language-guides/codeql-for-java/analyzing-data-flow-in-java.rst b/docs/codeql/codeql-language-guides/codeql-for-java/analyzing-data-flow-in-java.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-java/analyzing-data-flow-in-java.rst rename to docs/codeql/codeql-language-guides/codeql-for-java/analyzing-data-flow-in-java.rst diff --git a/docs/language/codeql-language-guides/codeql-for-java/annotations-in-java.rst b/docs/codeql/codeql-language-guides/codeql-for-java/annotations-in-java.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-java/annotations-in-java.rst rename to docs/codeql/codeql-language-guides/codeql-for-java/annotations-in-java.rst diff --git a/docs/language/codeql-language-guides/codeql-for-java/basic-query-for-java-code.rst b/docs/codeql/codeql-language-guides/codeql-for-java/basic-query-for-java-code.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-java/basic-query-for-java-code.rst rename to docs/codeql/codeql-language-guides/codeql-for-java/basic-query-for-java-code.rst diff --git a/docs/language/codeql-language-guides/codeql-for-java/codeql-library-for-java.rst b/docs/codeql/codeql-language-guides/codeql-for-java/codeql-library-for-java.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-java/codeql-library-for-java.rst rename to docs/codeql/codeql-language-guides/codeql-for-java/codeql-library-for-java.rst diff --git a/docs/language/codeql-language-guides/codeql-for-java/index.rst b/docs/codeql/codeql-language-guides/codeql-for-java/index.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-java/index.rst rename to docs/codeql/codeql-language-guides/codeql-for-java/index.rst diff --git a/docs/language/codeql-language-guides/codeql-for-java/javadoc.rst b/docs/codeql/codeql-language-guides/codeql-for-java/javadoc.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-java/javadoc.rst rename to docs/codeql/codeql-language-guides/codeql-for-java/javadoc.rst diff --git a/docs/language/codeql-language-guides/codeql-for-java/navigating-the-call-graph.rst b/docs/codeql/codeql-language-guides/codeql-for-java/navigating-the-call-graph.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-java/navigating-the-call-graph.rst rename to docs/codeql/codeql-language-guides/codeql-for-java/navigating-the-call-graph.rst diff --git a/docs/language/codeql-language-guides/codeql-for-java/overflow-prone-comparisons-in-java.rst b/docs/codeql/codeql-language-guides/codeql-for-java/overflow-prone-comparisons-in-java.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-java/overflow-prone-comparisons-in-java.rst rename to docs/codeql/codeql-language-guides/codeql-for-java/overflow-prone-comparisons-in-java.rst diff --git a/docs/language/codeql-language-guides/codeql-for-java/types-in-java.rst b/docs/codeql/codeql-language-guides/codeql-for-java/types-in-java.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-java/types-in-java.rst rename to docs/codeql/codeql-language-guides/codeql-for-java/types-in-java.rst diff --git a/docs/language/codeql-language-guides/codeql-for-java/working-with-source-locations.rst b/docs/codeql/codeql-language-guides/codeql-for-java/working-with-source-locations.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-java/working-with-source-locations.rst rename to docs/codeql/codeql-language-guides/codeql-for-java/working-with-source-locations.rst diff --git a/docs/language/codeql-language-guides/codeql-for-javascript/abstract-syntax-tree-classes-for-working-with-javascript-and-typescript-programs.rst b/docs/codeql/codeql-language-guides/codeql-for-javascript/abstract-syntax-tree-classes-for-working-with-javascript-and-typescript-programs.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-javascript/abstract-syntax-tree-classes-for-working-with-javascript-and-typescript-programs.rst rename to docs/codeql/codeql-language-guides/codeql-for-javascript/abstract-syntax-tree-classes-for-working-with-javascript-and-typescript-programs.rst diff --git a/docs/language/codeql-language-guides/codeql-for-javascript/analyzing-data-flow-in-javascript.rst b/docs/codeql/codeql-language-guides/codeql-for-javascript/analyzing-data-flow-in-javascript.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-javascript/analyzing-data-flow-in-javascript.rst rename to docs/codeql/codeql-language-guides/codeql-for-javascript/analyzing-data-flow-in-javascript.rst diff --git a/docs/language/codeql-language-guides/codeql-for-javascript/basic-query-for-javascript-code.rst b/docs/codeql/codeql-language-guides/codeql-for-javascript/basic-query-for-javascript-code.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-javascript/basic-query-for-javascript-code.rst rename to docs/codeql/codeql-language-guides/codeql-for-javascript/basic-query-for-javascript-code.rst diff --git a/docs/language/codeql-language-guides/codeql-for-javascript/codeql-library-for-javascript.rst b/docs/codeql/codeql-language-guides/codeql-for-javascript/codeql-library-for-javascript.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-javascript/codeql-library-for-javascript.rst rename to docs/codeql/codeql-language-guides/codeql-for-javascript/codeql-library-for-javascript.rst diff --git a/docs/language/codeql-language-guides/codeql-for-javascript/codeql-library-for-typescript.rst b/docs/codeql/codeql-language-guides/codeql-for-javascript/codeql-library-for-typescript.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-javascript/codeql-library-for-typescript.rst rename to docs/codeql/codeql-language-guides/codeql-for-javascript/codeql-library-for-typescript.rst diff --git a/docs/language/codeql-language-guides/codeql-for-javascript/data-flow-cheat-sheet-for-javascript.rst b/docs/codeql/codeql-language-guides/codeql-for-javascript/data-flow-cheat-sheet-for-javascript.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-javascript/data-flow-cheat-sheet-for-javascript.rst rename to docs/codeql/codeql-language-guides/codeql-for-javascript/data-flow-cheat-sheet-for-javascript.rst diff --git a/docs/language/codeql-language-guides/codeql-for-javascript/index.rst b/docs/codeql/codeql-language-guides/codeql-for-javascript/index.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-javascript/index.rst rename to docs/codeql/codeql-language-guides/codeql-for-javascript/index.rst diff --git a/docs/language/codeql-language-guides/codeql-for-javascript/using-flow-labels-for-precise-data-flow-analysis.rst b/docs/codeql/codeql-language-guides/codeql-for-javascript/using-flow-labels-for-precise-data-flow-analysis.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-javascript/using-flow-labels-for-precise-data-flow-analysis.rst rename to docs/codeql/codeql-language-guides/codeql-for-javascript/using-flow-labels-for-precise-data-flow-analysis.rst diff --git a/docs/language/codeql-language-guides/codeql-for-javascript/using-type-tracking-for-api-modeling.rst b/docs/codeql/codeql-language-guides/codeql-for-javascript/using-type-tracking-for-api-modeling.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-javascript/using-type-tracking-for-api-modeling.rst rename to docs/codeql/codeql-language-guides/codeql-for-javascript/using-type-tracking-for-api-modeling.rst diff --git a/docs/language/codeql-language-guides/codeql-for-python/analyzing-control-flow-in-python.rst b/docs/codeql/codeql-language-guides/codeql-for-python/analyzing-control-flow-in-python.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-python/analyzing-control-flow-in-python.rst rename to docs/codeql/codeql-language-guides/codeql-for-python/analyzing-control-flow-in-python.rst diff --git a/docs/language/codeql-language-guides/codeql-for-python/analyzing-data-flow-and-tracking-tainted-data-in-python.rst b/docs/codeql/codeql-language-guides/codeql-for-python/analyzing-data-flow-and-tracking-tainted-data-in-python.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-python/analyzing-data-flow-and-tracking-tainted-data-in-python.rst rename to docs/codeql/codeql-language-guides/codeql-for-python/analyzing-data-flow-and-tracking-tainted-data-in-python.rst diff --git a/docs/language/codeql-language-guides/codeql-for-python/basic-query-for-python-code.rst b/docs/codeql/codeql-language-guides/codeql-for-python/basic-query-for-python-code.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-python/basic-query-for-python-code.rst rename to docs/codeql/codeql-language-guides/codeql-for-python/basic-query-for-python-code.rst diff --git a/docs/language/codeql-language-guides/codeql-for-python/codeql-library-for-python.rst b/docs/codeql/codeql-language-guides/codeql-for-python/codeql-library-for-python.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-python/codeql-library-for-python.rst rename to docs/codeql/codeql-language-guides/codeql-for-python/codeql-library-for-python.rst diff --git a/docs/language/codeql-language-guides/codeql-for-python/expressions-and-statements-in-python.rst b/docs/codeql/codeql-language-guides/codeql-for-python/expressions-and-statements-in-python.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-python/expressions-and-statements-in-python.rst rename to docs/codeql/codeql-language-guides/codeql-for-python/expressions-and-statements-in-python.rst diff --git a/docs/language/codeql-language-guides/codeql-for-python/functions-in-python.rst b/docs/codeql/codeql-language-guides/codeql-for-python/functions-in-python.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-python/functions-in-python.rst rename to docs/codeql/codeql-language-guides/codeql-for-python/functions-in-python.rst diff --git a/docs/language/codeql-language-guides/codeql-for-python/index.rst b/docs/codeql/codeql-language-guides/codeql-for-python/index.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-python/index.rst rename to docs/codeql/codeql-language-guides/codeql-for-python/index.rst diff --git a/docs/language/codeql-language-guides/codeql-for-python/pointer-analysis-and-type-inference-in-python.rst b/docs/codeql/codeql-language-guides/codeql-for-python/pointer-analysis-and-type-inference-in-python.rst similarity index 100% rename from docs/language/codeql-language-guides/codeql-for-python/pointer-analysis-and-type-inference-in-python.rst rename to docs/codeql/codeql-language-guides/codeql-for-python/pointer-analysis-and-type-inference-in-python.rst diff --git a/docs/language/codeql-language-guides/index.rst b/docs/codeql/codeql-language-guides/index.rst similarity index 100% rename from docs/language/codeql-language-guides/index.rst rename to docs/codeql/codeql-language-guides/index.rst diff --git a/docs/language/codeql-overview/about-codeql.rst b/docs/codeql/codeql-overview/about-codeql.rst similarity index 100% rename from docs/language/codeql-overview/about-codeql.rst rename to docs/codeql/codeql-overview/about-codeql.rst diff --git a/docs/language/codeql-overview/codeql-glossary.rst b/docs/codeql/codeql-overview/codeql-glossary.rst similarity index 100% rename from docs/language/codeql-overview/codeql-glossary.rst rename to docs/codeql/codeql-overview/codeql-glossary.rst diff --git a/docs/language/codeql-overview/codeql-tools.rst b/docs/codeql/codeql-overview/codeql-tools.rst similarity index 100% rename from docs/language/codeql-overview/codeql-tools.rst rename to docs/codeql/codeql-overview/codeql-tools.rst diff --git a/docs/language/codeql-overview/index.rst b/docs/codeql/codeql-overview/index.rst similarity index 100% rename from docs/language/codeql-overview/index.rst rename to docs/codeql/codeql-overview/index.rst diff --git a/docs/language/codeql-overview/supported-languages-and-frameworks.rst b/docs/codeql/codeql-overview/supported-languages-and-frameworks.rst similarity index 100% rename from docs/language/codeql-overview/supported-languages-and-frameworks.rst rename to docs/codeql/codeql-overview/supported-languages-and-frameworks.rst diff --git a/docs/language/conf.py b/docs/codeql/conf.py similarity index 95% rename from docs/language/conf.py rename to docs/codeql/conf.py index 862c2debcc2..6372c6968b6 100644 --- a/docs/language/conf.py +++ b/docs/codeql/conf.py @@ -61,10 +61,6 @@ def setup(sphinx): from qllexer import QLLexer sphinx.add_lexer("ql", QLLexer()) -extensions = ['sphinx.ext.intersphinx'] - -intersphinx_mapping = {'codeql-cli-manual': ('http://docteam.internal.semmle.com/james/codeql-site-layout/codeql-cli-manual/', None)} - # 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. diff --git a/docs/language/codeql/images/choose-database.png b/docs/codeql/images/codeql-for-visual-studio-code/choose-database.png similarity index 100% rename from docs/language/codeql/images/choose-database.png rename to docs/codeql/images/codeql-for-visual-studio-code/choose-database.png diff --git a/docs/language/codeql/images/explore-ast.png b/docs/codeql/images/codeql-for-visual-studio-code/explore-ast.png similarity index 100% rename from docs/language/codeql/images/explore-ast.png rename to docs/codeql/images/codeql-for-visual-studio-code/explore-ast.png diff --git a/docs/language/codeql/images/open-extension-settings.png b/docs/codeql/images/codeql-for-visual-studio-code/open-extension-settings.png similarity index 100% rename from docs/language/codeql/images/open-extension-settings.png rename to docs/codeql/images/codeql-for-visual-studio-code/open-extension-settings.png diff --git a/docs/language/codeql/images/open-source-file.png b/docs/codeql/images/codeql-for-visual-studio-code/open-source-file.png similarity index 100% rename from docs/language/codeql/images/open-source-file.png rename to docs/codeql/images/codeql-for-visual-studio-code/open-source-file.png diff --git a/docs/language/codeql/images/open-test-explorer.png b/docs/codeql/images/codeql-for-visual-studio-code/open-test-explorer.png similarity index 100% rename from docs/language/codeql/images/open-test-explorer.png rename to docs/codeql/images/codeql-for-visual-studio-code/open-test-explorer.png diff --git a/docs/language/codeql/images/query-history.png b/docs/codeql/images/codeql-for-visual-studio-code/query-history.png similarity index 100% rename from docs/language/codeql/images/query-history.png rename to docs/codeql/images/codeql-for-visual-studio-code/query-history.png diff --git a/docs/language/codeql/images/run-multiple-queries.png b/docs/codeql/images/codeql-for-visual-studio-code/run-multiple-queries.png similarity index 100% rename from docs/language/codeql/images/run-multiple-queries.png rename to docs/codeql/images/codeql-for-visual-studio-code/run-multiple-queries.png diff --git a/docs/language/codeql/images/select-logs.png b/docs/codeql/images/codeql-for-visual-studio-code/select-logs.png similarity index 100% rename from docs/language/codeql/images/select-logs.png rename to docs/codeql/images/codeql-for-visual-studio-code/select-logs.png diff --git a/docs/language/codeql/images/show-test-diff.png b/docs/codeql/images/codeql-for-visual-studio-code/show-test-diff.png similarity index 100% rename from docs/language/codeql/images/show-test-diff.png rename to docs/codeql/images/codeql-for-visual-studio-code/show-test-diff.png diff --git a/docs/language/images/monotonic-aggregates-graph.png b/docs/codeql/images/monotonic-aggregates-graph.png similarity index 100% rename from docs/language/images/monotonic-aggregates-graph.png rename to docs/codeql/images/monotonic-aggregates-graph.png diff --git a/docs/language/images/python-flow-graph.png b/docs/codeql/images/python-flow-graph.png similarity index 100% rename from docs/language/images/python-flow-graph.png rename to docs/codeql/images/python-flow-graph.png diff --git a/docs/language/images/ql-select-statement-basic.png b/docs/codeql/images/ql-select-statement-basic.png similarity index 100% rename from docs/language/images/ql-select-statement-basic.png rename to docs/codeql/images/ql-select-statement-basic.png diff --git a/docs/language/images/ql-select-statement-filename.png b/docs/codeql/images/ql-select-statement-filename.png similarity index 100% rename from docs/language/images/ql-select-statement-filename.png rename to docs/codeql/images/ql-select-statement-filename.png diff --git a/docs/language/images/ql-select-statement-similarity.png b/docs/codeql/images/ql-select-statement-similarity.png similarity index 100% rename from docs/language/images/ql-select-statement-similarity.png rename to docs/codeql/images/ql-select-statement-similarity.png diff --git a/docs/language/images/query-metadata.png b/docs/codeql/images/query-metadata.png similarity index 100% rename from docs/language/images/query-metadata.png rename to docs/codeql/images/query-metadata.png diff --git a/docs/language/images/query-progress.png b/docs/codeql/images/query-progress.png similarity index 100% rename from docs/language/images/query-progress.png rename to docs/codeql/images/query-progress.png diff --git a/docs/language/index.rst b/docs/codeql/index.rst similarity index 100% rename from docs/language/index.rst rename to docs/codeql/index.rst diff --git a/docs/language/ql-language-reference/.gitignore b/docs/codeql/ql-language-reference/.gitignore similarity index 100% rename from docs/language/ql-language-reference/.gitignore rename to docs/codeql/ql-language-reference/.gitignore diff --git a/docs/language/ql-language-reference/about-the-ql-language.rst b/docs/codeql/ql-language-reference/about-the-ql-language.rst similarity index 100% rename from docs/language/ql-language-reference/about-the-ql-language.rst rename to docs/codeql/ql-language-reference/about-the-ql-language.rst diff --git a/docs/language/ql-language-reference/aliases.rst b/docs/codeql/ql-language-reference/aliases.rst similarity index 100% rename from docs/language/ql-language-reference/aliases.rst rename to docs/codeql/ql-language-reference/aliases.rst diff --git a/docs/language/ql-language-reference/annotations.rst b/docs/codeql/ql-language-reference/annotations.rst similarity index 100% rename from docs/language/ql-language-reference/annotations.rst rename to docs/codeql/ql-language-reference/annotations.rst diff --git a/docs/language/ql-language-reference/evaluation-of-ql-programs.rst b/docs/codeql/ql-language-reference/evaluation-of-ql-programs.rst similarity index 100% rename from docs/language/ql-language-reference/evaluation-of-ql-programs.rst rename to docs/codeql/ql-language-reference/evaluation-of-ql-programs.rst diff --git a/docs/language/ql-language-reference/expressions.rst b/docs/codeql/ql-language-reference/expressions.rst similarity index 100% rename from docs/language/ql-language-reference/expressions.rst rename to docs/codeql/ql-language-reference/expressions.rst diff --git a/docs/language/ql-language-reference/formulas.rst b/docs/codeql/ql-language-reference/formulas.rst similarity index 100% rename from docs/language/ql-language-reference/formulas.rst rename to docs/codeql/ql-language-reference/formulas.rst diff --git a/docs/language/ql-language-reference/index.rst b/docs/codeql/ql-language-reference/index.rst similarity index 100% rename from docs/language/ql-language-reference/index.rst rename to docs/codeql/ql-language-reference/index.rst diff --git a/docs/language/ql-language-reference/lexical-syntax.rst b/docs/codeql/ql-language-reference/lexical-syntax.rst similarity index 100% rename from docs/language/ql-language-reference/lexical-syntax.rst rename to docs/codeql/ql-language-reference/lexical-syntax.rst diff --git a/docs/language/ql-language-reference/modules.rst b/docs/codeql/ql-language-reference/modules.rst similarity index 100% rename from docs/language/ql-language-reference/modules.rst rename to docs/codeql/ql-language-reference/modules.rst diff --git a/docs/language/ql-language-reference/name-resolution.rst b/docs/codeql/ql-language-reference/name-resolution.rst similarity index 100% rename from docs/language/ql-language-reference/name-resolution.rst rename to docs/codeql/ql-language-reference/name-resolution.rst diff --git a/docs/language/ql-language-reference/predicates.rst b/docs/codeql/ql-language-reference/predicates.rst similarity index 100% rename from docs/language/ql-language-reference/predicates.rst rename to docs/codeql/ql-language-reference/predicates.rst diff --git a/docs/language/ql-language-reference/ql-language-specification.rst b/docs/codeql/ql-language-reference/ql-language-specification.rst similarity index 100% rename from docs/language/ql-language-reference/ql-language-specification.rst rename to docs/codeql/ql-language-reference/ql-language-specification.rst diff --git a/docs/language/ql-language-reference/qldoc-comment-specification.rst b/docs/codeql/ql-language-reference/qldoc-comment-specification.rst similarity index 100% rename from docs/language/ql-language-reference/qldoc-comment-specification.rst rename to docs/codeql/ql-language-reference/qldoc-comment-specification.rst diff --git a/docs/language/ql-language-reference/queries.rst b/docs/codeql/ql-language-reference/queries.rst similarity index 100% rename from docs/language/ql-language-reference/queries.rst rename to docs/codeql/ql-language-reference/queries.rst diff --git a/docs/language/ql-language-reference/recursion.rst b/docs/codeql/ql-language-reference/recursion.rst similarity index 100% rename from docs/language/ql-language-reference/recursion.rst rename to docs/codeql/ql-language-reference/recursion.rst diff --git a/docs/language/ql-language-reference/types.rst b/docs/codeql/ql-language-reference/types.rst similarity index 100% rename from docs/language/ql-language-reference/types.rst rename to docs/codeql/ql-language-reference/types.rst diff --git a/docs/language/ql-language-reference/variables.rst b/docs/codeql/ql-language-reference/variables.rst similarity index 100% rename from docs/language/ql-language-reference/variables.rst rename to docs/codeql/ql-language-reference/variables.rst diff --git a/docs/language/ql-training/_static-training/alternative-slide.svg b/docs/codeql/ql-training/_static-training/alternative-slide.svg similarity index 100% rename from docs/language/ql-training/_static-training/alternative-slide.svg rename to docs/codeql/ql-training/_static-training/alternative-slide.svg diff --git a/docs/language/ql-training/_static-training/analysis-overview.png b/docs/codeql/ql-training/_static-training/analysis-overview.png similarity index 100% rename from docs/language/ql-training/_static-training/analysis-overview.png rename to docs/codeql/ql-training/_static-training/analysis-overview.png diff --git a/docs/language/ql-training/_static-training/curiosity.png b/docs/codeql/ql-training/_static-training/curiosity.png similarity index 100% rename from docs/language/ql-training/_static-training/curiosity.png rename to docs/codeql/ql-training/_static-training/curiosity.png diff --git a/docs/language/ql-training/_static-training/curiosity2.png b/docs/codeql/ql-training/_static-training/curiosity2.png similarity index 100% rename from docs/language/ql-training/_static-training/curiosity2.png rename to docs/codeql/ql-training/_static-training/curiosity2.png diff --git a/docs/language/ql-training/_static-training/end-slide.svg b/docs/codeql/ql-training/_static-training/end-slide.svg similarity index 100% rename from docs/language/ql-training/_static-training/end-slide.svg rename to docs/codeql/ql-training/_static-training/end-slide.svg diff --git a/docs/language/ql-training/_static-training/java-data-flow-code-example.svg b/docs/codeql/ql-training/_static-training/java-data-flow-code-example.svg similarity index 100% rename from docs/language/ql-training/_static-training/java-data-flow-code-example.svg rename to docs/codeql/ql-training/_static-training/java-data-flow-code-example.svg diff --git a/docs/language/ql-training/_static-training/java-expression-ast.svg b/docs/codeql/ql-training/_static-training/java-expression-ast.svg similarity index 100% rename from docs/language/ql-training/_static-training/java-expression-ast.svg rename to docs/codeql/ql-training/_static-training/java-expression-ast.svg diff --git a/docs/language/ql-training/_static-training/mismatched-calls-and-returns.svg b/docs/codeql/ql-training/_static-training/mismatched-calls-and-returns.svg similarity index 100% rename from docs/language/ql-training/_static-training/mismatched-calls-and-returns.svg rename to docs/codeql/ql-training/_static-training/mismatched-calls-and-returns.svg diff --git a/docs/language/ql-training/_static-training/normal-slide.svg b/docs/codeql/ql-training/_static-training/normal-slide.svg similarity index 100% rename from docs/language/ql-training/_static-training/normal-slide.svg rename to docs/codeql/ql-training/_static-training/normal-slide.svg diff --git a/docs/language/ql-training/_static-training/setup-slide.svg b/docs/codeql/ql-training/_static-training/setup-slide.svg similarity index 100% rename from docs/language/ql-training/_static-training/setup-slide.svg rename to docs/codeql/ql-training/_static-training/setup-slide.svg diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/end_slide.html b/docs/codeql/ql-training/_static-training/slides-semmle-2/end_slide.html similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/end_slide.html rename to docs/codeql/ql-training/_static-training/slides-semmle-2/end_slide.html diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/layout.html b/docs/codeql/ql-training/_static-training/slides-semmle-2/layout.html similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/layout.html rename to docs/codeql/ql-training/_static-training/slides-semmle-2/layout.html diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/slide.html b/docs/codeql/ql-training/_static-training/slides-semmle-2/slide.html similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/slide.html rename to docs/codeql/ql-training/_static-training/slides-semmle-2/slide.html diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/config.rb b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/config.rb similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/config.rb rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/config.rb diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/hammer.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/hammer.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/hammer.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/hammer.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/modernizr.custom.45394.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/modernizr.custom.45394.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/modernizr.custom.45394.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/modernizr.custom.45394.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/order.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/order.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/order.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/order.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/polyfills/classList.min.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/polyfills/classList.min.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/polyfills/classList.min.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/polyfills/classList.min.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/polyfills/dataset.min.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/polyfills/dataset.min.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/polyfills/dataset.min.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/polyfills/dataset.min.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/polyfills/history.min.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/polyfills/history.min.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/polyfills/history.min.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/polyfills/history.min.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-apollo.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-apollo.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-apollo.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-apollo.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-clj.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-clj.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-clj.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-clj.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-css.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-css.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-css.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-css.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-go.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-go.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-go.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-go.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-hs.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-hs.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-hs.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-hs.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-lisp.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-lisp.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-lisp.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-lisp.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-lua.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-lua.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-lua.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-lua.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-ml.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-ml.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-ml.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-ml.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-n.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-n.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-n.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-n.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-proto.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-proto.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-proto.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-proto.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-scala.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-scala.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-scala.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-scala.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-sql.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-sql.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-sql.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-sql.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-tex.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-tex.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-tex.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-tex.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-vb.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-vb.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-vb.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-vb.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-vhdl.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-vhdl.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-vhdl.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-vhdl.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-wiki.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-wiki.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-wiki.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-wiki.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-xq.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-xq.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-xq.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-xq.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-yaml.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-yaml.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-yaml.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/lang-yaml.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/prettify.css b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/prettify.css similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/prettify.css rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/prettify.css diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/prettify.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/prettify.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/prettify/prettify.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/prettify/prettify.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/require-1.0.8.min.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/require-1.0.8.min.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/require-1.0.8.min.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/require-1.0.8.min.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/slide-controller.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/slide-controller.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/slide-controller.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/slide-controller.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/slide-deck-instantiate.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/slide-deck-instantiate.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/slide-deck-instantiate.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/slide-deck-instantiate.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/slide-deck.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/slide-deck.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/slide-deck.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/slide-deck.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/slide-testing.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/slide-testing.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/slide-testing.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/slide-testing.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/js/slides.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/slides.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/js/slides.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/js/slides.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/slide_config.js b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/slide_config.js similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/slide_config.js rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/slide_config.js diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/slide_config.js_t b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/slide_config.js_t similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/slide_config.js_t rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/slide_config.js_t diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/theme/css/default.css b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/css/default.css similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/theme/css/default.css rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/css/default.css diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/theme/css/hieroglyph.css b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/css/hieroglyph.css similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/theme/css/hieroglyph.css rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/css/hieroglyph.css diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/theme/css/io2013.css b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/css/io2013.css similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/theme/css/io2013.css rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/css/io2013.css diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/theme/css/phone.css b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/css/phone.css similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/theme/css/phone.css rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/css/phone.css diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/theme/scss/_base.scss b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/scss/_base.scss similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/theme/scss/_base.scss rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/scss/_base.scss diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/theme/scss/_variables.scss b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/scss/_variables.scss similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/theme/scss/_variables.scss rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/scss/_variables.scss diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/theme/scss/default.scss b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/scss/default.scss similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/theme/scss/default.scss rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/scss/default.scss diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/theme/scss/hieroglyph.scss b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/scss/hieroglyph.scss similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/theme/scss/hieroglyph.scss rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/scss/hieroglyph.scss diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/theme/scss/io2013.scss b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/scss/io2013.scss similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/theme/scss/io2013.scss rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/scss/io2013.scss diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/static/theme/scss/phone.scss b/docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/scss/phone.scss similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/static/theme/scss/phone.scss rename to docs/codeql/ql-training/_static-training/slides-semmle-2/static/theme/scss/phone.scss diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/theme.conf b/docs/codeql/ql-training/_static-training/slides-semmle-2/theme.conf similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/theme.conf rename to docs/codeql/ql-training/_static-training/slides-semmle-2/theme.conf diff --git a/docs/language/ql-training/_static-training/slides-semmle-2/title_slide.html b/docs/codeql/ql-training/_static-training/slides-semmle-2/title_slide.html similarity index 100% rename from docs/language/ql-training/_static-training/slides-semmle-2/title_slide.html rename to docs/codeql/ql-training/_static-training/slides-semmle-2/title_slide.html diff --git a/docs/language/ql-training/_static-training/title-slide.svg b/docs/codeql/ql-training/_static-training/title-slide.svg similarity index 100% rename from docs/language/ql-training/_static-training/title-slide.svg rename to docs/codeql/ql-training/_static-training/title-slide.svg diff --git a/docs/language/ql-training/conf.py b/docs/codeql/ql-training/conf.py similarity index 100% rename from docs/language/ql-training/conf.py rename to docs/codeql/ql-training/conf.py diff --git a/docs/language/ql-training/cpp/bad-overflow-guard.rst b/docs/codeql/ql-training/cpp/bad-overflow-guard.rst similarity index 100% rename from docs/language/ql-training/cpp/bad-overflow-guard.rst rename to docs/codeql/ql-training/cpp/bad-overflow-guard.rst diff --git a/docs/language/ql-training/cpp/control-flow-cpp.rst b/docs/codeql/ql-training/cpp/control-flow-cpp.rst similarity index 100% rename from docs/language/ql-training/cpp/control-flow-cpp.rst rename to docs/codeql/ql-training/cpp/control-flow-cpp.rst diff --git a/docs/language/ql-training/cpp/data-flow-cpp.rst b/docs/codeql/ql-training/cpp/data-flow-cpp.rst similarity index 100% rename from docs/language/ql-training/cpp/data-flow-cpp.rst rename to docs/codeql/ql-training/cpp/data-flow-cpp.rst diff --git a/docs/language/ql-training/cpp/global-data-flow-cpp.rst b/docs/codeql/ql-training/cpp/global-data-flow-cpp.rst similarity index 100% rename from docs/language/ql-training/cpp/global-data-flow-cpp.rst rename to docs/codeql/ql-training/cpp/global-data-flow-cpp.rst diff --git a/docs/language/ql-training/cpp/intro-ql-cpp.rst b/docs/codeql/ql-training/cpp/intro-ql-cpp.rst similarity index 100% rename from docs/language/ql-training/cpp/intro-ql-cpp.rst rename to docs/codeql/ql-training/cpp/intro-ql-cpp.rst diff --git a/docs/language/ql-training/cpp/program-representation-cpp.rst b/docs/codeql/ql-training/cpp/program-representation-cpp.rst similarity index 100% rename from docs/language/ql-training/cpp/program-representation-cpp.rst rename to docs/codeql/ql-training/cpp/program-representation-cpp.rst diff --git a/docs/language/ql-training/cpp/snprintf.rst b/docs/codeql/ql-training/cpp/snprintf.rst similarity index 100% rename from docs/language/ql-training/cpp/snprintf.rst rename to docs/codeql/ql-training/cpp/snprintf.rst diff --git a/docs/language/ql-training/index.rst b/docs/codeql/ql-training/index.rst similarity index 100% rename from docs/language/ql-training/index.rst rename to docs/codeql/ql-training/index.rst diff --git a/docs/language/ql-training/java/apache-struts-java.rst b/docs/codeql/ql-training/java/apache-struts-java.rst similarity index 100% rename from docs/language/ql-training/java/apache-struts-java.rst rename to docs/codeql/ql-training/java/apache-struts-java.rst diff --git a/docs/language/ql-training/java/data-flow-java.rst b/docs/codeql/ql-training/java/data-flow-java.rst similarity index 100% rename from docs/language/ql-training/java/data-flow-java.rst rename to docs/codeql/ql-training/java/data-flow-java.rst diff --git a/docs/language/ql-training/java/global-data-flow-java.rst b/docs/codeql/ql-training/java/global-data-flow-java.rst similarity index 100% rename from docs/language/ql-training/java/global-data-flow-java.rst rename to docs/codeql/ql-training/java/global-data-flow-java.rst diff --git a/docs/language/ql-training/java/intro-ql-java.rst b/docs/codeql/ql-training/java/intro-ql-java.rst similarity index 100% rename from docs/language/ql-training/java/intro-ql-java.rst rename to docs/codeql/ql-training/java/intro-ql-java.rst diff --git a/docs/language/ql-training/java/program-representation-java.rst b/docs/codeql/ql-training/java/program-representation-java.rst similarity index 100% rename from docs/language/ql-training/java/program-representation-java.rst rename to docs/codeql/ql-training/java/program-representation-java.rst diff --git a/docs/language/ql-training/java/query-injection-java.rst b/docs/codeql/ql-training/java/query-injection-java.rst similarity index 100% rename from docs/language/ql-training/java/query-injection-java.rst rename to docs/codeql/ql-training/java/query-injection-java.rst diff --git a/docs/language/ql-training/query-examples/cpp/bad-overflow-guard-1.ql b/docs/codeql/ql-training/query-examples/cpp/bad-overflow-guard-1.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/bad-overflow-guard-1.ql rename to docs/codeql/ql-training/query-examples/cpp/bad-overflow-guard-1.ql diff --git a/docs/language/ql-training/query-examples/cpp/bad-overflow-guard-2.ql b/docs/codeql/ql-training/query-examples/cpp/bad-overflow-guard-2.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/bad-overflow-guard-2.ql rename to docs/codeql/ql-training/query-examples/cpp/bad-overflow-guard-2.ql diff --git a/docs/language/ql-training/query-examples/cpp/bad-overflow-guard-3.ql b/docs/codeql/ql-training/query-examples/cpp/bad-overflow-guard-3.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/bad-overflow-guard-3.ql rename to docs/codeql/ql-training/query-examples/cpp/bad-overflow-guard-3.ql diff --git a/docs/language/ql-training/query-examples/cpp/control-flow-cpp-1.ql b/docs/codeql/ql-training/query-examples/cpp/control-flow-cpp-1.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/control-flow-cpp-1.ql rename to docs/codeql/ql-training/query-examples/cpp/control-flow-cpp-1.ql diff --git a/docs/language/ql-training/query-examples/cpp/control-flow-cpp-2.ql b/docs/codeql/ql-training/query-examples/cpp/control-flow-cpp-2.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/control-flow-cpp-2.ql rename to docs/codeql/ql-training/query-examples/cpp/control-flow-cpp-2.ql diff --git a/docs/language/ql-training/query-examples/cpp/control-flow-cpp-3.ql b/docs/codeql/ql-training/query-examples/cpp/control-flow-cpp-3.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/control-flow-cpp-3.ql rename to docs/codeql/ql-training/query-examples/cpp/control-flow-cpp-3.ql diff --git a/docs/language/ql-training/query-examples/cpp/control-flow-cpp-4.ql b/docs/codeql/ql-training/query-examples/cpp/control-flow-cpp-4.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/control-flow-cpp-4.ql rename to docs/codeql/ql-training/query-examples/cpp/control-flow-cpp-4.ql diff --git a/docs/language/ql-training/query-examples/cpp/control-flow-cpp-5.ql b/docs/codeql/ql-training/query-examples/cpp/control-flow-cpp-5.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/control-flow-cpp-5.ql rename to docs/codeql/ql-training/query-examples/cpp/control-flow-cpp-5.ql diff --git a/docs/language/ql-training/query-examples/cpp/data-flow-cpp-1.ql b/docs/codeql/ql-training/query-examples/cpp/data-flow-cpp-1.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/data-flow-cpp-1.ql rename to docs/codeql/ql-training/query-examples/cpp/data-flow-cpp-1.ql diff --git a/docs/language/ql-training/query-examples/cpp/data-flow-cpp-2.ql b/docs/codeql/ql-training/query-examples/cpp/data-flow-cpp-2.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/data-flow-cpp-2.ql rename to docs/codeql/ql-training/query-examples/cpp/data-flow-cpp-2.ql diff --git a/docs/language/ql-training/query-examples/cpp/empty-if-cpp-class.ql b/docs/codeql/ql-training/query-examples/cpp/empty-if-cpp-class.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/empty-if-cpp-class.ql rename to docs/codeql/ql-training/query-examples/cpp/empty-if-cpp-class.ql diff --git a/docs/language/ql-training/query-examples/cpp/empty-if-cpp-model.ql b/docs/codeql/ql-training/query-examples/cpp/empty-if-cpp-model.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/empty-if-cpp-model.ql rename to docs/codeql/ql-training/query-examples/cpp/empty-if-cpp-model.ql diff --git a/docs/language/ql-training/query-examples/cpp/empty-if-cpp-predicate.ql b/docs/codeql/ql-training/query-examples/cpp/empty-if-cpp-predicate.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/empty-if-cpp-predicate.ql rename to docs/codeql/ql-training/query-examples/cpp/empty-if-cpp-predicate.ql diff --git a/docs/language/ql-training/query-examples/cpp/empty-if-cpp.ql b/docs/codeql/ql-training/query-examples/cpp/empty-if-cpp.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/empty-if-cpp.ql rename to docs/codeql/ql-training/query-examples/cpp/empty-if-cpp.ql diff --git a/docs/language/ql-training/query-examples/cpp/global-data-flow-cpp-1.ql b/docs/codeql/ql-training/query-examples/cpp/global-data-flow-cpp-1.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/global-data-flow-cpp-1.ql rename to docs/codeql/ql-training/query-examples/cpp/global-data-flow-cpp-1.ql diff --git a/docs/language/ql-training/query-examples/cpp/snprintf-1.ql b/docs/codeql/ql-training/query-examples/cpp/snprintf-1.ql similarity index 100% rename from docs/language/ql-training/query-examples/cpp/snprintf-1.ql rename to docs/codeql/ql-training/query-examples/cpp/snprintf-1.ql diff --git a/docs/language/ql-training/query-examples/java/data-flow-java-1.ql b/docs/codeql/ql-training/query-examples/java/data-flow-java-1.ql similarity index 100% rename from docs/language/ql-training/query-examples/java/data-flow-java-1.ql rename to docs/codeql/ql-training/query-examples/java/data-flow-java-1.ql diff --git a/docs/language/ql-training/query-examples/java/data-flow-java-2.ql b/docs/codeql/ql-training/query-examples/java/data-flow-java-2.ql similarity index 100% rename from docs/language/ql-training/query-examples/java/data-flow-java-2.ql rename to docs/codeql/ql-training/query-examples/java/data-flow-java-2.ql diff --git a/docs/language/ql-training/query-examples/java/empty-if-java-class.ql b/docs/codeql/ql-training/query-examples/java/empty-if-java-class.ql similarity index 100% rename from docs/language/ql-training/query-examples/java/empty-if-java-class.ql rename to docs/codeql/ql-training/query-examples/java/empty-if-java-class.ql diff --git a/docs/language/ql-training/query-examples/java/empty-if-java-model.ql b/docs/codeql/ql-training/query-examples/java/empty-if-java-model.ql similarity index 100% rename from docs/language/ql-training/query-examples/java/empty-if-java-model.ql rename to docs/codeql/ql-training/query-examples/java/empty-if-java-model.ql diff --git a/docs/language/ql-training/query-examples/java/empty-if-java-predicate.ql b/docs/codeql/ql-training/query-examples/java/empty-if-java-predicate.ql similarity index 100% rename from docs/language/ql-training/query-examples/java/empty-if-java-predicate.ql rename to docs/codeql/ql-training/query-examples/java/empty-if-java-predicate.ql diff --git a/docs/language/ql-training/query-examples/java/empty-if-java.ql b/docs/codeql/ql-training/query-examples/java/empty-if-java.ql similarity index 100% rename from docs/language/ql-training/query-examples/java/empty-if-java.ql rename to docs/codeql/ql-training/query-examples/java/empty-if-java.ql diff --git a/docs/language/ql-training/query-examples/java/global-data-flow-java-1.ql b/docs/codeql/ql-training/query-examples/java/global-data-flow-java-1.ql similarity index 100% rename from docs/language/ql-training/query-examples/java/global-data-flow-java-1.ql rename to docs/codeql/ql-training/query-examples/java/global-data-flow-java-1.ql diff --git a/docs/language/ql-training/query-examples/java/query-injection-java-1.ql b/docs/codeql/ql-training/query-examples/java/query-injection-java-1.ql similarity index 100% rename from docs/language/ql-training/query-examples/java/query-injection-java-1.ql rename to docs/codeql/ql-training/query-examples/java/query-injection-java-1.ql diff --git a/docs/language/ql-training/query-examples/java/query-injection-java-2.ql b/docs/codeql/ql-training/query-examples/java/query-injection-java-2.ql similarity index 100% rename from docs/language/ql-training/query-examples/java/query-injection-java-2.ql rename to docs/codeql/ql-training/query-examples/java/query-injection-java-2.ql diff --git a/docs/language/ql-training/query-examples/java/query-injection-java-3.ql b/docs/codeql/ql-training/query-examples/java/query-injection-java-3.ql similarity index 100% rename from docs/language/ql-training/query-examples/java/query-injection-java-3.ql rename to docs/codeql/ql-training/query-examples/java/query-injection-java-3.ql diff --git a/docs/language/ql-training/slide-snippets/abstract-syntax-tree.rst b/docs/codeql/ql-training/slide-snippets/abstract-syntax-tree.rst similarity index 100% rename from docs/language/ql-training/slide-snippets/abstract-syntax-tree.rst rename to docs/codeql/ql-training/slide-snippets/abstract-syntax-tree.rst diff --git a/docs/language/ql-training/slide-snippets/database-note.rst b/docs/codeql/ql-training/slide-snippets/database-note.rst similarity index 100% rename from docs/language/ql-training/slide-snippets/database-note.rst rename to docs/codeql/ql-training/slide-snippets/database-note.rst diff --git a/docs/language/ql-training/slide-snippets/global-data-flow-extra-slides.rst b/docs/codeql/ql-training/slide-snippets/global-data-flow-extra-slides.rst similarity index 100% rename from docs/language/ql-training/slide-snippets/global-data-flow-extra-slides.rst rename to docs/codeql/ql-training/slide-snippets/global-data-flow-extra-slides.rst diff --git a/docs/language/ql-training/slide-snippets/global-data-flow.rst b/docs/codeql/ql-training/slide-snippets/global-data-flow.rst similarity index 100% rename from docs/language/ql-training/slide-snippets/global-data-flow.rst rename to docs/codeql/ql-training/slide-snippets/global-data-flow.rst diff --git a/docs/language/ql-training/slide-snippets/intro-ql-general.rst b/docs/codeql/ql-training/slide-snippets/intro-ql-general.rst similarity index 100% rename from docs/language/ql-training/slide-snippets/intro-ql-general.rst rename to docs/codeql/ql-training/slide-snippets/intro-ql-general.rst diff --git a/docs/language/ql-training/slide-snippets/local-data-flow.rst b/docs/codeql/ql-training/slide-snippets/local-data-flow.rst similarity index 100% rename from docs/language/ql-training/slide-snippets/local-data-flow.rst rename to docs/codeql/ql-training/slide-snippets/local-data-flow.rst diff --git a/docs/language/ql-training/slide-snippets/path-queries.rst b/docs/codeql/ql-training/slide-snippets/path-queries.rst similarity index 100% rename from docs/language/ql-training/slide-snippets/path-queries.rst rename to docs/codeql/ql-training/slide-snippets/path-queries.rst diff --git a/docs/language/ql-training/template.rst b/docs/codeql/ql-training/template.rst similarity index 100% rename from docs/language/ql-training/template.rst rename to docs/codeql/ql-training/template.rst diff --git a/docs/language/qllexer.py b/docs/codeql/qllexer.py similarity index 100% rename from docs/language/qllexer.py rename to docs/codeql/qllexer.py diff --git a/docs/language/reusables/abstract-syntax-tree.rst b/docs/codeql/reusables/abstract-syntax-tree.rst similarity index 100% rename from docs/language/reusables/abstract-syntax-tree.rst rename to docs/codeql/reusables/abstract-syntax-tree.rst diff --git a/docs/language/reusables/advanced-query-execution.rst b/docs/codeql/reusables/advanced-query-execution.rst similarity index 70% rename from docs/language/reusables/advanced-query-execution.rst rename to docs/codeql/reusables/advanced-query-execution.rst index 03bdec4c568..0519939f0d9 100644 --- a/docs/language/reusables/advanced-query-execution.rst +++ b/docs/codeql/reusables/advanced-query-execution.rst @@ -4,15 +4,15 @@ `. You can also execute queries using the following plumbing-level subcommands: - - :doc:`database run-queries `, which + - `database run-queries <../codeql-cli-manual/database-run-queries.html>`__, which outputs non-interpreted results in an intermediate binary format called :ref:`BQRS `. - - :doc:`query run `, which will output BQRS files, or print + - `query run <../codeql-cli-manual/query-run.html>`__, which will output BQRS files, or print results tables directly to the command line. Viewing results directly in the command line may be useful for iterative query development using the CLI. Queries run with these commands don't have the same metadata requirements. However, to save human-readable data you have to process each BQRS results - file using the :doc:`bqrs decode ` plumbing + file using the `bqrs decode <../codeql-cli-manual/bqrs-decode.html>`__ plumbing subcommand. Therefore, for most use cases it's easiest to use ``database analyze`` to directly generate interpreted results. \ No newline at end of file diff --git a/docs/language/codeql/snippets/codeql-cli-overview.rst b/docs/codeql/reusables/codeql-cli-overview.rst similarity index 100% rename from docs/language/codeql/snippets/codeql-cli-overview.rst rename to docs/codeql/reusables/codeql-cli-overview.rst diff --git a/docs/language/reusables/codeql-ref-tools-further-reading.rst b/docs/codeql/reusables/codeql-ref-tools-further-reading.rst similarity index 100% rename from docs/language/reusables/codeql-ref-tools-further-reading.rst rename to docs/codeql/reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/language/reusables/cpp-further-reading.rst b/docs/codeql/reusables/cpp-further-reading.rst similarity index 100% rename from docs/language/reusables/cpp-further-reading.rst rename to docs/codeql/reusables/cpp-further-reading.rst diff --git a/docs/language/reusables/csharp-further-reading.rst b/docs/codeql/reusables/csharp-further-reading.rst similarity index 100% rename from docs/language/reusables/csharp-further-reading.rst rename to docs/codeql/reusables/csharp-further-reading.rst diff --git a/docs/language/codeql/snippets/download-lgtm-database.rst b/docs/codeql/reusables/download-lgtm-database.rst similarity index 100% rename from docs/language/codeql/snippets/download-lgtm-database.rst rename to docs/codeql/reusables/download-lgtm-database.rst diff --git a/docs/language/codeql/snippets/extractors.rst b/docs/codeql/reusables/extractors.rst similarity index 100% rename from docs/language/codeql/snippets/extractors.rst rename to docs/codeql/reusables/extractors.rst diff --git a/docs/language/reusables/go-further-reading.rst b/docs/codeql/reusables/go-further-reading.rst similarity index 100% rename from docs/language/reusables/go-further-reading.rst rename to docs/codeql/reusables/go-further-reading.rst diff --git a/docs/language/codeql/snippets/index-files-note.rst b/docs/codeql/reusables/index-files-note.rst similarity index 100% rename from docs/language/codeql/snippets/index-files-note.rst rename to docs/codeql/reusables/index-files-note.rst diff --git a/docs/language/reusables/java-further-reading.rst b/docs/codeql/reusables/java-further-reading.rst similarity index 100% rename from docs/language/reusables/java-further-reading.rst rename to docs/codeql/reusables/java-further-reading.rst diff --git a/docs/language/reusables/javascript-further-reading.rst b/docs/codeql/reusables/javascript-further-reading.rst similarity index 100% rename from docs/language/reusables/javascript-further-reading.rst rename to docs/codeql/reusables/javascript-further-reading.rst diff --git a/docs/language/codeql/snippets/license-note.rst b/docs/codeql/reusables/license-note.rst similarity index 100% rename from docs/language/codeql/snippets/license-note.rst rename to docs/codeql/reusables/license-note.rst diff --git a/docs/language/reusables/path-problem.rst b/docs/codeql/reusables/path-problem.rst similarity index 100% rename from docs/language/reusables/path-problem.rst rename to docs/codeql/reusables/path-problem.rst diff --git a/docs/language/reusables/python-further-reading.rst b/docs/codeql/reusables/python-further-reading.rst similarity index 100% rename from docs/language/reusables/python-further-reading.rst rename to docs/codeql/reusables/python-further-reading.rst diff --git a/docs/language/reusables/running-queries-debug.rst b/docs/codeql/reusables/running-queries-debug.rst similarity index 100% rename from docs/language/reusables/running-queries-debug.rst rename to docs/codeql/reusables/running-queries-debug.rst diff --git a/docs/language/codeql/snippets/test-qlpack.rst b/docs/codeql/reusables/test-qlpack.rst similarity index 100% rename from docs/language/codeql/snippets/test-qlpack.rst rename to docs/codeql/reusables/test-qlpack.rst diff --git a/docs/language/codeql/snippets/threads-query-execution.rst b/docs/codeql/reusables/threads-query-execution.rst similarity index 100% rename from docs/language/codeql/snippets/threads-query-execution.rst rename to docs/codeql/reusables/threads-query-execution.rst diff --git a/docs/language/support/conf.py b/docs/codeql/support/conf.py similarity index 69% rename from docs/language/support/conf.py rename to docs/codeql/support/conf.py index e88bdfce1bb..1647b35eb35 100644 --- a/docs/language/support/conf.py +++ b/docs/codeql/support/conf.py @@ -1,7 +1,6 @@ # -*- coding: utf-8 -*- # -# CodeQL and LGTM support info build configuration file, created -# on Tuesday 19th February. +# CodeQL analysis support for LGTM Enterprise docs build configuration file. # # This file is execfile()d with the current directory set to its # containing dir. @@ -27,27 +26,24 @@ # -- 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()) - # Set QL as the default language for highlighting code. Set to none to disable # syntax highlighting. If omitted or left blank, it defaults to Python 3. -highlight_language ='none' +highlight_language = 'none' + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' # The master toctree document. master_doc = 'index' # Project-specific information. -project = u'Supported languages and frameworks' +project = u'Supported languages and frameworks for LGTM Enterprise' # The version info for this project, if different from version and release in main conf.py file. # The short X.Y version. -# version = u'1.20' +version = u'1.26' # The full version, including alpha/beta/rc tags. -# release = u'1.20' +release = u'1.26' # -- Project-specifc options for HTML output ---------------------------------------------- @@ -58,6 +54,23 @@ html_title = 'Supported languages and frameworks' # Output file base name for HTML help builder. htmlhelp_basename = 'Supported languages and frameworks' +# Add any paths that contain templates here, relative to this directory. +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". +html_static_path = ['../_static'] + +html_theme_options = {'font_size': '16px', + 'body_text': '#333', + 'link': '#2F1695', + 'link_hover': '#2F1695', + 'font_family': 'Inter,-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Segoe UI Symbol;', + 'show_powered_by': False, + 'nosidebar':True, + } + # -- Currently unused, but potentially useful, configs-------------------------------------- # Add any paths that contain custom themes here, relative to this directory. diff --git a/docs/language/support/framework-support.rst b/docs/codeql/support/framework-support.rst similarity index 100% rename from docs/language/support/framework-support.rst rename to docs/codeql/support/framework-support.rst diff --git a/docs/language/support/index.rst b/docs/codeql/support/index.rst similarity index 100% rename from docs/language/support/index.rst rename to docs/codeql/support/index.rst diff --git a/docs/language/support/language-support.rst b/docs/codeql/support/language-support.rst similarity index 100% rename from docs/language/support/language-support.rst rename to docs/codeql/support/language-support.rst diff --git a/docs/language/support/read-me-project.rst b/docs/codeql/support/read-me-project.rst similarity index 100% rename from docs/language/support/read-me-project.rst rename to docs/codeql/support/read-me-project.rst diff --git a/docs/language/support/reusables/frameworks.rst b/docs/codeql/support/reusables/frameworks.rst similarity index 100% rename from docs/language/support/reusables/frameworks.rst rename to docs/codeql/support/reusables/frameworks.rst diff --git a/docs/language/support/reusables/versions-compilers.rst b/docs/codeql/support/reusables/versions-compilers.rst similarity index 100% rename from docs/language/support/reusables/versions-compilers.rst rename to docs/codeql/support/reusables/versions-compilers.rst diff --git a/docs/language/vale-styles/Microsoft/AMPM.yml b/docs/codeql/vale-styles/Microsoft/AMPM.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/AMPM.yml rename to docs/codeql/vale-styles/Microsoft/AMPM.yml diff --git a/docs/language/vale-styles/Microsoft/Accessibility.yml b/docs/codeql/vale-styles/Microsoft/Accessibility.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Accessibility.yml rename to docs/codeql/vale-styles/Microsoft/Accessibility.yml diff --git a/docs/language/vale-styles/Microsoft/Acronyms.yml b/docs/codeql/vale-styles/Microsoft/Acronyms.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Acronyms.yml rename to docs/codeql/vale-styles/Microsoft/Acronyms.yml diff --git a/docs/language/vale-styles/Microsoft/Adverbs.yml b/docs/codeql/vale-styles/Microsoft/Adverbs.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Adverbs.yml rename to docs/codeql/vale-styles/Microsoft/Adverbs.yml diff --git a/docs/language/vale-styles/Microsoft/Auto.yml b/docs/codeql/vale-styles/Microsoft/Auto.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Auto.yml rename to docs/codeql/vale-styles/Microsoft/Auto.yml diff --git a/docs/language/vale-styles/Microsoft/Avoid.yml b/docs/codeql/vale-styles/Microsoft/Avoid.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Avoid.yml rename to docs/codeql/vale-styles/Microsoft/Avoid.yml diff --git a/docs/language/vale-styles/Microsoft/Backend.yml b/docs/codeql/vale-styles/Microsoft/Backend.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Backend.yml rename to docs/codeql/vale-styles/Microsoft/Backend.yml diff --git a/docs/language/vale-styles/Microsoft/ComplexWords.yml b/docs/codeql/vale-styles/Microsoft/ComplexWords.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/ComplexWords.yml rename to docs/codeql/vale-styles/Microsoft/ComplexWords.yml diff --git a/docs/language/vale-styles/Microsoft/Contractions.yml b/docs/codeql/vale-styles/Microsoft/Contractions.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Contractions.yml rename to docs/codeql/vale-styles/Microsoft/Contractions.yml diff --git a/docs/language/vale-styles/Microsoft/Dashes.yml b/docs/codeql/vale-styles/Microsoft/Dashes.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Dashes.yml rename to docs/codeql/vale-styles/Microsoft/Dashes.yml diff --git a/docs/language/vale-styles/Microsoft/DateFormat.yml b/docs/codeql/vale-styles/Microsoft/DateFormat.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/DateFormat.yml rename to docs/codeql/vale-styles/Microsoft/DateFormat.yml diff --git a/docs/language/vale-styles/Microsoft/DateNumbers.yml b/docs/codeql/vale-styles/Microsoft/DateNumbers.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/DateNumbers.yml rename to docs/codeql/vale-styles/Microsoft/DateNumbers.yml diff --git a/docs/language/vale-styles/Microsoft/DateOrder.yml b/docs/codeql/vale-styles/Microsoft/DateOrder.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/DateOrder.yml rename to docs/codeql/vale-styles/Microsoft/DateOrder.yml diff --git a/docs/language/vale-styles/Microsoft/Ellipses.yml b/docs/codeql/vale-styles/Microsoft/Ellipses.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Ellipses.yml rename to docs/codeql/vale-styles/Microsoft/Ellipses.yml diff --git a/docs/language/vale-styles/Microsoft/FirstPerson.yml b/docs/codeql/vale-styles/Microsoft/FirstPerson.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/FirstPerson.yml rename to docs/codeql/vale-styles/Microsoft/FirstPerson.yml diff --git a/docs/language/vale-styles/Microsoft/Foreign.yml b/docs/codeql/vale-styles/Microsoft/Foreign.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Foreign.yml rename to docs/codeql/vale-styles/Microsoft/Foreign.yml diff --git a/docs/language/vale-styles/Microsoft/Gender.yml b/docs/codeql/vale-styles/Microsoft/Gender.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Gender.yml rename to docs/codeql/vale-styles/Microsoft/Gender.yml diff --git a/docs/language/vale-styles/Microsoft/GenderBias.yml b/docs/codeql/vale-styles/Microsoft/GenderBias.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/GenderBias.yml rename to docs/codeql/vale-styles/Microsoft/GenderBias.yml diff --git a/docs/language/vale-styles/Microsoft/GeneralURL.yml b/docs/codeql/vale-styles/Microsoft/GeneralURL.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/GeneralURL.yml rename to docs/codeql/vale-styles/Microsoft/GeneralURL.yml diff --git a/docs/language/vale-styles/Microsoft/HeadingAcronyms.yml b/docs/codeql/vale-styles/Microsoft/HeadingAcronyms.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/HeadingAcronyms.yml rename to docs/codeql/vale-styles/Microsoft/HeadingAcronyms.yml diff --git a/docs/language/vale-styles/Microsoft/HeadingColons.yml b/docs/codeql/vale-styles/Microsoft/HeadingColons.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/HeadingColons.yml rename to docs/codeql/vale-styles/Microsoft/HeadingColons.yml diff --git a/docs/language/vale-styles/Microsoft/HeadingPunctuation.yml b/docs/codeql/vale-styles/Microsoft/HeadingPunctuation.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/HeadingPunctuation.yml rename to docs/codeql/vale-styles/Microsoft/HeadingPunctuation.yml diff --git a/docs/language/vale-styles/Microsoft/Headings.yml b/docs/codeql/vale-styles/Microsoft/Headings.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Headings.yml rename to docs/codeql/vale-styles/Microsoft/Headings.yml diff --git a/docs/language/vale-styles/Microsoft/Hyphens.yml b/docs/codeql/vale-styles/Microsoft/Hyphens.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Hyphens.yml rename to docs/codeql/vale-styles/Microsoft/Hyphens.yml diff --git a/docs/language/vale-styles/Microsoft/Negative.yml b/docs/codeql/vale-styles/Microsoft/Negative.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Negative.yml rename to docs/codeql/vale-styles/Microsoft/Negative.yml diff --git a/docs/language/vale-styles/Microsoft/Ordinal.yml b/docs/codeql/vale-styles/Microsoft/Ordinal.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Ordinal.yml rename to docs/codeql/vale-styles/Microsoft/Ordinal.yml diff --git a/docs/language/vale-styles/Microsoft/OxfordComma.yml b/docs/codeql/vale-styles/Microsoft/OxfordComma.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/OxfordComma.yml rename to docs/codeql/vale-styles/Microsoft/OxfordComma.yml diff --git a/docs/language/vale-styles/Microsoft/Passive.yml b/docs/codeql/vale-styles/Microsoft/Passive.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Passive.yml rename to docs/codeql/vale-styles/Microsoft/Passive.yml diff --git a/docs/language/vale-styles/Microsoft/Percentages.yml b/docs/codeql/vale-styles/Microsoft/Percentages.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Percentages.yml rename to docs/codeql/vale-styles/Microsoft/Percentages.yml diff --git a/docs/language/vale-styles/Microsoft/Quotes.yml b/docs/codeql/vale-styles/Microsoft/Quotes.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Quotes.yml rename to docs/codeql/vale-styles/Microsoft/Quotes.yml diff --git a/docs/language/vale-styles/Microsoft/RangeFormat.yml b/docs/codeql/vale-styles/Microsoft/RangeFormat.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/RangeFormat.yml rename to docs/codeql/vale-styles/Microsoft/RangeFormat.yml diff --git a/docs/language/vale-styles/Microsoft/RangeTime.yml b/docs/codeql/vale-styles/Microsoft/RangeTime.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/RangeTime.yml rename to docs/codeql/vale-styles/Microsoft/RangeTime.yml diff --git a/docs/language/vale-styles/Microsoft/Ranges.yml b/docs/codeql/vale-styles/Microsoft/Ranges.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Ranges.yml rename to docs/codeql/vale-styles/Microsoft/Ranges.yml diff --git a/docs/language/vale-styles/Microsoft/Semicolon.yml b/docs/codeql/vale-styles/Microsoft/Semicolon.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Semicolon.yml rename to docs/codeql/vale-styles/Microsoft/Semicolon.yml diff --git a/docs/language/vale-styles/Microsoft/SentenceLength.yml b/docs/codeql/vale-styles/Microsoft/SentenceLength.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/SentenceLength.yml rename to docs/codeql/vale-styles/Microsoft/SentenceLength.yml diff --git a/docs/language/vale-styles/Microsoft/Spacing.yml b/docs/codeql/vale-styles/Microsoft/Spacing.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Spacing.yml rename to docs/codeql/vale-styles/Microsoft/Spacing.yml diff --git a/docs/language/vale-styles/Microsoft/Suspended.yml b/docs/codeql/vale-styles/Microsoft/Suspended.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Suspended.yml rename to docs/codeql/vale-styles/Microsoft/Suspended.yml diff --git a/docs/language/vale-styles/Microsoft/Terms.yml b/docs/codeql/vale-styles/Microsoft/Terms.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Terms.yml rename to docs/codeql/vale-styles/Microsoft/Terms.yml diff --git a/docs/language/vale-styles/Microsoft/URLFormat.yml b/docs/codeql/vale-styles/Microsoft/URLFormat.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/URLFormat.yml rename to docs/codeql/vale-styles/Microsoft/URLFormat.yml diff --git a/docs/language/vale-styles/Microsoft/Units.yml b/docs/codeql/vale-styles/Microsoft/Units.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Units.yml rename to docs/codeql/vale-styles/Microsoft/Units.yml diff --git a/docs/language/vale-styles/Microsoft/Vocab.yml b/docs/codeql/vale-styles/Microsoft/Vocab.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Vocab.yml rename to docs/codeql/vale-styles/Microsoft/Vocab.yml diff --git a/docs/language/vale-styles/Microsoft/We.yml b/docs/codeql/vale-styles/Microsoft/We.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/We.yml rename to docs/codeql/vale-styles/Microsoft/We.yml diff --git a/docs/language/vale-styles/Microsoft/Wordiness.yml b/docs/codeql/vale-styles/Microsoft/Wordiness.yml similarity index 100% rename from docs/language/vale-styles/Microsoft/Wordiness.yml rename to docs/codeql/vale-styles/Microsoft/Wordiness.yml diff --git a/docs/language/vale-styles/Microsoft/meta.json b/docs/codeql/vale-styles/Microsoft/meta.json similarity index 100% rename from docs/language/vale-styles/Microsoft/meta.json rename to docs/codeql/vale-styles/Microsoft/meta.json diff --git a/docs/language/vale-styles/Microsoft/vocab.txt b/docs/codeql/vale-styles/Microsoft/vocab.txt similarity index 100% rename from docs/language/vale-styles/Microsoft/vocab.txt rename to docs/codeql/vale-styles/Microsoft/vocab.txt diff --git a/docs/language/vale-styles/README.md b/docs/codeql/vale-styles/README.md similarity index 100% rename from docs/language/vale-styles/README.md rename to docs/codeql/vale-styles/README.md diff --git a/docs/language/vale-styles/Semmle/Headings.yml b/docs/codeql/vale-styles/Semmle/Headings.yml similarity index 100% rename from docs/language/vale-styles/Semmle/Headings.yml rename to docs/codeql/vale-styles/Semmle/Headings.yml diff --git a/docs/language/vale-styles/Semmle/Spelling.yml b/docs/codeql/vale-styles/Semmle/Spelling.yml similarity index 100% rename from docs/language/vale-styles/Semmle/Spelling.yml rename to docs/codeql/vale-styles/Semmle/Spelling.yml diff --git a/docs/language/vale-styles/Semmle/ignore.txt b/docs/codeql/vale-styles/Semmle/ignore.txt similarity index 100% rename from docs/language/vale-styles/Semmle/ignore.txt rename to docs/codeql/vale-styles/Semmle/ignore.txt diff --git a/docs/language/writing-codeql-queries/codeql-queries/about-codeql-queries.rst b/docs/codeql/writing-codeql-queries/codeql-queries/about-codeql-queries.rst similarity index 100% rename from docs/language/writing-codeql-queries/codeql-queries/about-codeql-queries.rst rename to docs/codeql/writing-codeql-queries/codeql-queries/about-codeql-queries.rst diff --git a/docs/language/writing-codeql-queries/codeql-queries/about-data-flow-analysis.rst b/docs/codeql/writing-codeql-queries/codeql-queries/about-data-flow-analysis.rst similarity index 100% rename from docs/language/writing-codeql-queries/codeql-queries/about-data-flow-analysis.rst rename to docs/codeql/writing-codeql-queries/codeql-queries/about-data-flow-analysis.rst diff --git a/docs/language/writing-codeql-queries/codeql-queries/creating-path-queries.rst b/docs/codeql/writing-codeql-queries/codeql-queries/creating-path-queries.rst similarity index 100% rename from docs/language/writing-codeql-queries/codeql-queries/creating-path-queries.rst rename to docs/codeql/writing-codeql-queries/codeql-queries/creating-path-queries.rst diff --git a/docs/language/writing-codeql-queries/codeql-queries/defining-the-results-of-a-query.rst b/docs/codeql/writing-codeql-queries/codeql-queries/defining-the-results-of-a-query.rst similarity index 100% rename from docs/language/writing-codeql-queries/codeql-queries/defining-the-results-of-a-query.rst rename to docs/codeql/writing-codeql-queries/codeql-queries/defining-the-results-of-a-query.rst diff --git a/docs/language/writing-codeql-queries/codeql-queries/index.rst b/docs/codeql/writing-codeql-queries/codeql-queries/index.rst similarity index 100% rename from docs/language/writing-codeql-queries/codeql-queries/index.rst rename to docs/codeql/writing-codeql-queries/codeql-queries/index.rst diff --git a/docs/language/writing-codeql-queries/codeql-queries/metadata-for-codeql-queries.rst b/docs/codeql/writing-codeql-queries/codeql-queries/metadata-for-codeql-queries.rst similarity index 100% rename from docs/language/writing-codeql-queries/codeql-queries/metadata-for-codeql-queries.rst rename to docs/codeql/writing-codeql-queries/codeql-queries/metadata-for-codeql-queries.rst diff --git a/docs/language/writing-codeql-queries/codeql-queries/providing-locations-in-codeql-queries.rst b/docs/codeql/writing-codeql-queries/codeql-queries/providing-locations-in-codeql-queries.rst similarity index 100% rename from docs/language/writing-codeql-queries/codeql-queries/providing-locations-in-codeql-queries.rst rename to docs/codeql/writing-codeql-queries/codeql-queries/providing-locations-in-codeql-queries.rst diff --git a/docs/language/writing-codeql-queries/codeql-queries/query-help-files.rst b/docs/codeql/writing-codeql-queries/codeql-queries/query-help-files.rst similarity index 100% rename from docs/language/writing-codeql-queries/codeql-queries/query-help-files.rst rename to docs/codeql/writing-codeql-queries/codeql-queries/query-help-files.rst diff --git a/docs/language/writing-codeql-queries/codeql-queries/troubleshooting-query-performance.rst b/docs/codeql/writing-codeql-queries/codeql-queries/troubleshooting-query-performance.rst similarity index 100% rename from docs/language/writing-codeql-queries/codeql-queries/troubleshooting-query-performance.rst rename to docs/codeql/writing-codeql-queries/codeql-queries/troubleshooting-query-performance.rst diff --git a/docs/language/writing-codeql-queries/index.rst b/docs/codeql/writing-codeql-queries/index.rst similarity index 100% rename from docs/language/writing-codeql-queries/index.rst rename to docs/codeql/writing-codeql-queries/index.rst diff --git a/docs/language/writing-codeql-queries/ql-tutorials/catch-the-fire-starter.rst b/docs/codeql/writing-codeql-queries/ql-tutorials/catch-the-fire-starter.rst similarity index 100% rename from docs/language/writing-codeql-queries/ql-tutorials/catch-the-fire-starter.rst rename to docs/codeql/writing-codeql-queries/ql-tutorials/catch-the-fire-starter.rst diff --git a/docs/language/writing-codeql-queries/ql-tutorials/cross-the-river.rst b/docs/codeql/writing-codeql-queries/ql-tutorials/cross-the-river.rst similarity index 100% rename from docs/language/writing-codeql-queries/ql-tutorials/cross-the-river.rst rename to docs/codeql/writing-codeql-queries/ql-tutorials/cross-the-river.rst diff --git a/docs/language/writing-codeql-queries/ql-tutorials/crown-the-rightful-heir.rst b/docs/codeql/writing-codeql-queries/ql-tutorials/crown-the-rightful-heir.rst similarity index 100% rename from docs/language/writing-codeql-queries/ql-tutorials/crown-the-rightful-heir.rst rename to docs/codeql/writing-codeql-queries/ql-tutorials/crown-the-rightful-heir.rst diff --git a/docs/language/writing-codeql-queries/ql-tutorials/find-the-thief.rst b/docs/codeql/writing-codeql-queries/ql-tutorials/find-the-thief.rst similarity index 100% rename from docs/language/writing-codeql-queries/ql-tutorials/find-the-thief.rst rename to docs/codeql/writing-codeql-queries/ql-tutorials/find-the-thief.rst diff --git a/docs/language/writing-codeql-queries/ql-tutorials/index.rst b/docs/codeql/writing-codeql-queries/ql-tutorials/index.rst similarity index 100% rename from docs/language/writing-codeql-queries/ql-tutorials/index.rst rename to docs/codeql/writing-codeql-queries/ql-tutorials/index.rst diff --git a/docs/language/writing-codeql-queries/ql-tutorials/introduction-to-ql.rst b/docs/codeql/writing-codeql-queries/ql-tutorials/introduction-to-ql.rst similarity index 100% rename from docs/language/writing-codeql-queries/ql-tutorials/introduction-to-ql.rst rename to docs/codeql/writing-codeql-queries/ql-tutorials/introduction-to-ql.rst diff --git a/docs/language/writing-codeql-queries/ql-tutorials/river-crossing-1.ql b/docs/codeql/writing-codeql-queries/ql-tutorials/river-crossing-1.ql similarity index 100% rename from docs/language/writing-codeql-queries/ql-tutorials/river-crossing-1.ql rename to docs/codeql/writing-codeql-queries/ql-tutorials/river-crossing-1.ql diff --git a/docs/language/writing-codeql-queries/ql-tutorials/river-crossing.ql b/docs/codeql/writing-codeql-queries/ql-tutorials/river-crossing.ql similarity index 100% rename from docs/language/writing-codeql-queries/ql-tutorials/river-crossing.ql rename to docs/codeql/writing-codeql-queries/ql-tutorials/river-crossing.ql diff --git a/docs/language/codeql/.gitignore b/docs/language/codeql/.gitignore deleted file mode 100644 index 772e11ea16b..00000000000 --- a/docs/language/codeql/.gitignore +++ /dev/null @@ -1,8 +0,0 @@ -# VSCode rst extension build directory -_build/ - -# VSCode rst extension settings -.vscode - -# QLlexer .pyc files -**/*.pyc \ No newline at end of file diff --git a/docs/language/codeql/codeql-cli.rst b/docs/language/codeql/codeql-cli.rst deleted file mode 100644 index 9b2c4992698..00000000000 --- a/docs/language/codeql/codeql-cli.rst +++ /dev/null @@ -1,60 +0,0 @@ -CodeQL CLI -========== - -.. include:: snippets/codeql-cli-overview.rst - -See the following links to learn how to get set up and run CodeQL commands: - -- :doc:`About the CodeQL CLI `: Software - developers and security researchers can secure their code using the CodeQL CLI. - -- :doc:`Getting started with the CodeQL CLI - `: Set up the - CodeQL CLI so that you can run CodeQL processes from your command line. - -- :doc:`Creating CodeQL databases - `: Create relational - representations of source code that can be queried like any other database. - -- :doc:`Analyzing CodeQL databases - `: Analyze your code using queries - written in a specially-designed, object-oriented query language. - -- :doc:`Upgrading CodeQL databases - `: Upgrade your databases so - that they can be analyzed using the most up to date CodeQL products. - -- :doc:`Using custom queries with the CodeQL CLI - `: Use custom queries to extend your - analysis or highlight errors that are specific to a particular codebase. - -- :doc:`Creating CodeQL query suites `: - Define query suite definitions for groups of frequently used queries. - -- :doc:`Testing custom queries `: Set up - regression testing of custom queries to ensure that they behave as expected in - your analysis. - -- :doc:`Testing query help files `: - Test query help files by rendering them as markdown to ensure they are valid - before uploading them to the CodeQL repository or using them in code scanning. - -For more information about the CLI commands, see the ":doc:`CodeQL CLI reference -`." - -.. toctree:: - :titlesonly: - :hidden: - - codeql-cli/about-the-codeql-cli - codeql-cli/procedures/getting-started-with-the-codeql-cli - codeql-cli/procedures/creating-codeql-databases - codeql-cli/procedures/analyzing-databases-with-the-codeql-cli - codeql-cli/procedures/upgrading-codeql-databases - codeql-cli/procedures/using-custom-queries-with-the-codeql-cli - codeql-cli/procedures/creating-codeql-query-suites - codeql-cli/procedures/testing-custom-queries - codeql-cli/procedures/testing-query-help-files - codeql-cli/codeql-cli-reference - codeql-cli/changelog - diff --git a/docs/language/codeql/codeql-for-visual-studio-code.rst b/docs/language/codeql/codeql-for-visual-studio-code.rst deleted file mode 100644 index fd7a9ac77bd..00000000000 --- a/docs/language/codeql/codeql-for-visual-studio-code.rst +++ /dev/null @@ -1,53 +0,0 @@ -CodeQL for Visual Studio Code -============================= - -The CodeQL extension for Visual Studio Code adds rich language support for CodeQL and allows you to easily find problems in codebases. - -See the following help topics for more information: - -- :doc:`About CodeQL for Visual Studio Code - `: CodeQL for Visual Studio - Code is an extension that lets you write, run, and test CodeQL queries in Visual - Studio Code. - -- :doc:`Setting up CodeQL in Visual Studio Code - `: You can install and configure - the CodeQL extension in Visual Studio Code. - -- :doc:`Analyzing your projects - `: You can run queries on CodeQL - databases and view the results in Visual Studio Code. - -- :doc:`Exploring the structure of your source code - `: - You can use the AST viewer to display the abstract syntax tree of a CodeQL database. - -- :doc:`Exploring data flow with path queries - `: You can run CodeQL queries in - VS Code to help you track the flow of data through a program, highlighting - areas that are potential security vulnerabilities. - -- :doc:`Testing CodeQL queries in Visual Studio Code - `: You can run unit tests for - CodeQL queries using the Visual Studio Code extension. - -- :doc:`Customizing customizing-settings - `: You can edit the settings for the - CodeQL extension to suit your needs. - -- :doc:`Troubleshooting CodeQL for Visual Studio Code - `: You can use the detailed - information written to the extension's log files if you need to troubleshoot problems. - -.. toctree:: - :hidden: - :titlesonly: - - codeql-for-vscode/procedures/about-codeql-for-visual-studio-code - codeql-for-vscode/procedures/setting-up-codeql-in-visual-studio-code - codeql-for-vscode/procedures/analyzing-your-projects - codeql-for-vscode/procedures/exploring-the-structure-of-your-source-code - codeql-for-vscode/procedures/exploring-data-flow-with-path-queries - codeql-for-vscode/procedures/testing-codeql-queries-in-visual-studio-code - codeql-for-vscode/reference/customizing-settings - codeql-for-vscode/procedures/troubleshooting-codeql-for-visual-studio-code diff --git a/docs/language/codeql/conf.py b/docs/language/codeql/conf.py deleted file mode 100644 index a023385420c..00000000000 --- a/docs/language/codeql/conf.py +++ /dev/null @@ -1,92 +0,0 @@ -# -*- coding: utf-8 -*- -# -# CodeQL documentation build configuration file, created -# on Oct 02 2019. -# -# 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 - -# The configuration values below are specific to the learning ql project -# 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()) - -# Set QL as the default language for highlighting code. Set to none to disable -# syntax highlighting. If omitted or left blank, it defaults to Python 3. -highlight_language = 'none' - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['../global-sphinx-files/_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". -html_static_path = ['../global-sphinx-files/_static'] - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'CodeQL documentation' - -# -- Project-specifc options for HTML output ---------------------------------------------- - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -html_title = 'CodeQL' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'CodeQL' - -# The version info for this project, if different from version and release in main conf.py file. -# The short X.Y version. -# version = u'GitHub Universe' -# The full version, including alpha/beta/rc tags. -# release = u'GitHub Universe' - -# 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. - -exclude_patterns = ['codeql-cli/commands-toc.rst', 'glossary/*', 'snippets/*'] - -# -- 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 = [] - -# You can use this to specify substitutions -# rst_prolog = """ """ \ No newline at end of file diff --git a/docs/language/codeql/index.rst b/docs/language/codeql/index.rst deleted file mode 100644 index fc1e27b063c..00000000000 --- a/docs/language/codeql/index.rst +++ /dev/null @@ -1,41 +0,0 @@ -CodeQL -====== - -CodeQL is the code analysis platform used by security researchers to automate -variant analysis---the process of using a known software security vulnerability -as the seed for finding related bugs. - -Visit the links below to learn more about CodeQL, analyzing your project from the -command line using the CodeQL command-line interface, and running CodeQL -analysis in Visual Studio Code. - -.. pull-quote:: - - Note - - If you've previously used the QL command-line tools, you'll notice a few - differences. For more information, see ":doc:`Notes for legacy QL CLI users - `." - -- :doc:`About CodeQL `: - CodeQL is the analysis engine used by developers to automate security checks, and by - security researchers to perform variant analysis. - -- :doc:`CodeQL for Visual Studio Code extension `: - You can analyze CodeQL databases in Visual Studio Code using the CodeQL - extension, which provides an enhanced environment for writing and running custom - queries and viewing the results. - -- :doc:`CodeQL command-line interface `: The CodeQL command-line - interface (CLI) is used to create databases for security research. You can query - CodeQL databases directly from the command line or using the Visual Studio Code - extension. - -.. toctree:: - :hidden: - :titlesonly: - - codeql-overview - codeql-for-visual-studio-code - codeql-cli - notes-ql-users diff --git a/docs/language/codeql/notes-ql-users.rst b/docs/language/codeql/notes-ql-users.rst deleted file mode 100644 index 4857fefdc67..00000000000 --- a/docs/language/codeql/notes-ql-users.rst +++ /dev/null @@ -1,106 +0,0 @@ -Notes for legacy QL CLI users -============================= - -If you've previously used the QL command-line tools (``odasa``), you'll notice a -few key differences when you use the new CodeQL products: - -* "QL snapshots" are now called :ref:`CodeQL databases `. -* The process of creating a CodeQL database is much simpler and more streamlined. - There's no need to create ``projects`` or ``snapshots``---just check out the - code and build it using the CodeQL CLI ``codeql database create`` command. -* Queries are run against CodeQL databases using the CodeQL CLI ``codeql - database analyze`` command. - -For more information, see ":doc:`Creating CodeQL databases -`" and -":doc:`Analyzing databases with the CodeQL CLI `." -For detailed guidance about equivalent commands, see `Overview of common codeql-cli-reference -<#overview-of-common-codeql-cli-reference>`__ below. - -.. _database-compatibiilty-notes: - -Database compatibility notes ----------------------------- - -A CodeQL database created by the CodeQL CLI serves the same purpose as a QL -snapshot created using ``odasa``. They both contain a code database to query and -usually a source reference for results display. However, they are not identical -formats and, if you use the legacy QL tools alongside the CodeQL tools, you need -to make the adjustments described below. - -.. pull-quote:: - - Note - - .. include:: snippets/index-files-note.rst - -Using existing QL snapshots created by the legacy CLI -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Existing QL snapshots, exported using the legacy CLI, can be used with the new -CodeQL tools. Unzip the snapshot and treat the directory as a database. If it -was built with an earlier version of the legacy CLI, you may need to upgrade -the database using ``codeql database upgrade``. For more information, see the -:doc:`database upgrade reference documentation -`. - -.. _database-compatibiilty-codeql-for-eclipse: - -Preparing a CodeQL database for import into CodeQL for Eclipse -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -CodeQL databases are not directly compatible with CodeQL for Eclipse. -However, you can "bundle" a CodeQL database into the required format by running:: - - codeql database bundle --include-uncompressed-source -o - -The resulting database can be imported directly into CodeQL for Eclipse. For more -information about the ``bundle`` command, see the :doc:`database bundle reference documentation -`. - -Preparing a CodeQL database for upload into LGTM Enterprise -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -CodeQL databases cannot be directly uploaded to an LGTM Enterprise instance. -For more information, see `Preparing CodeQL databases to upload to LGTM -`__ -in the LGTM admin help. - -Query suites ------------- - -CodeQL includes a new, more flexible, format for query suites. Legacy query -suite definitions are not compatible with the new CodeQL tools. For more -information about CodeQL query suites, see ":doc:`Creating CodeQL query suites -`." - -Overview of common commands ---------------------------- - -If you're switching from the legacy ODASA CLI to the new CodeQL CLI, -the table below shows which commands replace the most -common ODASA processes. - -+------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ``odasa`` command | Corresponding ``codeql`` command | Notes | -+==========================================+===================================================================================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ -| ``bootstrap`` | n/a | CodeQL analysis does not use ``project`` files during database creation. For more information about creating databases, see `Creating CodeQL databases `__. | -+------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ``addSnapshot``, ``addLatestSnapshot`` | n/a | To obtain the version of the code you want to analyze, just run your normal check-out commands. | -+------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ``buildSnapshot`` | `database create `__ | When creating a CodeQL database, you specfiy build commands in the command line, rather than in a project file. For more information, see `Creating CodeQL databases `__. | -+------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ``analyzeSnapshot`` | `database analyze `__ | For more information, see "`Analyzing databases with the CodeQL CLI `__." | -+------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ``archiveSnapshot`` | `database cleanup `__ | Use ``database cleanup`` to reduce the size of a CodeQL database by deleting temporary data. | -+------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ``export`` | `database bundle `__ | You don't need to export databases before adding them to VS Code. However, you should "bundle" CodeQL databases before using them with LGTM Enterprise, CodeQL for Eclipse, or CodeQL for Visual Studio. For more information, see `Preparing CodeQL databases to upload to LGTM `__ in the LGTM admin help and the `Database compatibility notes <#database-compatibility-notes>`__. | -+------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ``prepareQueries`` | `query compile `__ | Queries are compiled when you run ``database analyze`` and other query-running commands. You can speed up compilation by running ``query compile`` separately using more threads. | -+------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ``qltest`` | `test run `__ | For more information about running regression tests, see "`Testing custom queries `__." | -+------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ``runQuery`` | `query run `__ | Use ``query run`` to quickly view results in your terminal. To generate interpreted results that can be viewed in source code, use ``database analyze``. | -+------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ``upgrade`` | `database upgrade `__ | For more information, see "`Upgrading CodeQL databases `__." | -+------------------------------------------+---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/language/codeql/snippets/advanced-query-execution.rst b/docs/language/codeql/snippets/advanced-query-execution.rst deleted file mode 100644 index 0119f0c0b2d..00000000000 --- a/docs/language/codeql/snippets/advanced-query-execution.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. pull-quote:: Other query-running commands - - Queries run with ``database analyze`` have strict :ref:`metadata requirements - `. You can also execute queries using the following - plumbing-level subcommands: - - - :doc:`database run-queries <../commands/database-run-queries>`, which - outputs non-interpreted results in an intermediate binary format called - :ref:`BQRS `. - - :doc:`query run <../commands/query-run>`, which will output BQRS files, or print - results tables directly to the command line. Viewing results directly in - the command line may be useful for iterative query development using the CLI. - - Queries run with these commands don't have the same metadata requirements. - However, to save human-readable data you have to process each BQRS results - file using the :doc:`bqrs decode <../commands/bqrs-decode>` plumbing - subcommand. Therefore, for most use cases it's easiest to use ``database - analyze`` to directly generate interpreted results. \ No newline at end of file diff --git a/docs/language/codeql/snippets/running-queries-debug.rst b/docs/language/codeql/snippets/running-queries-debug.rst deleted file mode 100644 index 3df217bafa8..00000000000 --- a/docs/language/codeql/snippets/running-queries-debug.rst +++ /dev/null @@ -1 +0,0 @@ -If you want to examine query performance, enable the **Running Queries: Debug** setting to include timing and tuple counts in the CodeQL Query Server logs shown in the Output view. The tuple count is useful because it indicates the size of the `predicates `__ computed by the query. \ No newline at end of file diff --git a/docs/language/images/codeql-for-visual-studio-code/choose-database.png b/docs/language/images/codeql-for-visual-studio-code/choose-database.png deleted file mode 100644 index 71ca5d6b4c3..00000000000 Binary files a/docs/language/images/codeql-for-visual-studio-code/choose-database.png and /dev/null differ diff --git a/docs/language/images/codeql-for-visual-studio-code/explore-ast.png b/docs/language/images/codeql-for-visual-studio-code/explore-ast.png deleted file mode 100644 index 1cdbd1d92e9..00000000000 Binary files a/docs/language/images/codeql-for-visual-studio-code/explore-ast.png and /dev/null differ diff --git a/docs/language/images/codeql-for-visual-studio-code/open-extension-settings.png b/docs/language/images/codeql-for-visual-studio-code/open-extension-settings.png deleted file mode 100644 index 631388fce68..00000000000 Binary files a/docs/language/images/codeql-for-visual-studio-code/open-extension-settings.png and /dev/null differ diff --git a/docs/language/images/codeql-for-visual-studio-code/open-source-file.png b/docs/language/images/codeql-for-visual-studio-code/open-source-file.png deleted file mode 100644 index 316798fcd7c..00000000000 Binary files a/docs/language/images/codeql-for-visual-studio-code/open-source-file.png and /dev/null differ diff --git a/docs/language/images/codeql-for-visual-studio-code/open-test-explorer.png b/docs/language/images/codeql-for-visual-studio-code/open-test-explorer.png deleted file mode 100644 index b5a2a16824a..00000000000 Binary files a/docs/language/images/codeql-for-visual-studio-code/open-test-explorer.png and /dev/null differ diff --git a/docs/language/images/codeql-for-visual-studio-code/query-history.png b/docs/language/images/codeql-for-visual-studio-code/query-history.png deleted file mode 100644 index c648fa78f87..00000000000 Binary files a/docs/language/images/codeql-for-visual-studio-code/query-history.png and /dev/null differ diff --git a/docs/language/images/codeql-for-visual-studio-code/run-multiple-queries.png b/docs/language/images/codeql-for-visual-studio-code/run-multiple-queries.png deleted file mode 100644 index 0e764b762a8..00000000000 Binary files a/docs/language/images/codeql-for-visual-studio-code/run-multiple-queries.png and /dev/null differ diff --git a/docs/language/images/codeql-for-visual-studio-code/select-logs.png b/docs/language/images/codeql-for-visual-studio-code/select-logs.png deleted file mode 100644 index 5d078ba4949..00000000000 Binary files a/docs/language/images/codeql-for-visual-studio-code/select-logs.png and /dev/null differ diff --git a/docs/language/images/codeql-for-visual-studio-code/show-test-diff.png b/docs/language/images/codeql-for-visual-studio-code/show-test-diff.png deleted file mode 100644 index 7b1e45d194f..00000000000 Binary files a/docs/language/images/codeql-for-visual-studio-code/show-test-diff.png and /dev/null differ diff --git a/docs/language/learn-ql/conf.py b/docs/language/learn-ql/conf.py deleted file mode 100644 index 94d3bf2205f..00000000000 --- a/docs/language/learn-ql/conf.py +++ /dev/null @@ -1,83 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Learn CodeQL documentation build configuration file, created by -# on Tuesday Nov 13 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 learning ql project -# 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()) - -# Set QL as the default language for highlighting code. Set to none to disable -# syntax highlighting. If omitted or left blank, it defaults to Python 3. -highlight_language = 'ql' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Learning CodeQL' - -# -- Project-specifc options for HTML output ---------------------------------------------- - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -html_title = 'Learn CodeQL' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Learn CodeQL' - -# The version info for this project, if different from version and release in main conf.py file. -# The short X.Y version. -# version = u'1.18' -# The full version, including alpha/beta/rc tags. -# release = u'1.18' - -# -- 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 = [''] \ No newline at end of file diff --git a/docs/language/learn-ql/index.rst b/docs/language/learn-ql/index.rst deleted file mode 100644 index 54f8c9c91d7..00000000000 --- a/docs/language/learn-ql/index.rst +++ /dev/null @@ -1,39 +0,0 @@ -Learning CodeQL -############### - -CodeQL is the code analysis platform used by security researchers to automate variant analysis. -You can use CodeQL queries to explore code and quickly find variants of security vulnerabilities and bugs. -These queries are easy to write and share–visit the topics below and `our open source repository on GitHub `__ to learn more. -You can also try out CodeQL in the `query console on LGTM.com `__. -Here, you can query open source projects directly, without having to download CodeQL databases and libraries. - -CodeQL is based on a powerful query language called QL. The following topics help you understand QL in general, as well as how to use it when analyzing code with CodeQL. - -.. pull-quote:: - - Important - - If you've previously used QL, you may notice slight changes in terms we use to describe some important concepts. For more information, see our note about ":doc:`Recent terminology changes `." - -.. toctree:: - :maxdepth: 1 - - beginner/ql-tutorials - writing-queries/codeql-queries - cpp/codeql-for-cpp - csharp/codeql-for-csharp - go/codeql-for-go - java/codeql-for-java - javascript/codeql-for-javascript - python/codeql-for-python - ql-training - -.. toctree:: - :hidden: - - terminology-note - -Further reading -*************** - -- `QL language reference `__: A description of important concepts in QL and a formal specification of the QL language. diff --git a/docs/language/learn-ql/ql-training.rst b/docs/language/learn-ql/ql-training.rst deleted file mode 100644 index 61fc0551ecc..00000000000 --- a/docs/language/learn-ql/ql-training.rst +++ /dev/null @@ -1,63 +0,0 @@ -CodeQL training and variant analysis examples -============================================= - -CodeQL and variant analysis ---------------------------- - -Variant analysis is the process of using a known vulnerability as a seed to find similar problems in your code. Security engineers typically perform variant analysis to identify possible vulnerabilities and to ensure that these threats are properly fixed across multiple code bases. - -CodeQL is the code analysis engine that underpins LGTM, the community driven security analysis platform. Together, CodeQL and LGTM provide continuous monitoring and scalable variant analysis for your projects, even if you don’t have your own team of dedicated security engineers. You can read more about using CodeQL and LGTM in variant analysis on the `Security Lab research page `__. - -CodeQL is easy to learn, and exploring code using CodeQL is the most efficient way to perform variant analysis. - -Learning CodeQL for variant analysis ------------------------------------- - -Start learning how to use CodeQL in variant analysis for a specific language by looking at the topics below. Each topic links to a short presentation on CodeQL, its libraries, or an example variant discovered using CodeQL. - -.. |arrow-l| unicode:: U+2190 - -.. |arrow-r| unicode:: U+2192 - -.. |info| unicode:: U+24D8 - -When you have selected a presentation, use |arrow-r| and |arrow-l| to navigate between slides. -Press **p** to view the additional notes on slides that have an information icon |info| in the top right corner, and press **f** to enter full-screen mode. - -The presentations contain a number of query examples. -We recommend that you download `CodeQL for Visual Studio Code `__ and add the example database for each presentation so that you can find the bugs mentioned in the slides. - - -.. pull-quote:: - - Information - - The presentations listed below are used in CodeQL and variant analysis training sessions run by GitHub engineers. - Therefore, be aware that the slides are designed to be presented by an instructor. - If you are using the slides without an instructor, please use the additional notes to help guide you through the examples. - -CodeQL and variant analysis for C/C++ -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- `Introduction to variant analysis: CodeQL for C/C++ <../ql-training/cpp/intro-ql-cpp.html>`__–an introduction to variant analysis and CodeQL for C/C++ programmers. -- `Example: Bad overflow guard <../ql-training/cpp/bad-overflow-guard.html>`__–an example of iterative query development to find bad overflow guards in a C++ project. -- `Program representation: CodeQL for C/C++ <../ql-training/cpp/program-representation-cpp.html>`__–information on how CodeQL analysis represents C/C++ programs. -- `Introduction to local data flow <../ql-training/cpp/data-flow-cpp.html>`__–an introduction to analyzing local data flow in C/C++ using CodeQL, including an example demonstrating how to develop a query to find a real CVE. -- `Exercise: snprintf overflow <../ql-training/cpp/snprintf.html>`__–an example demonstrating how to develop a data flow query. -- `Introduction to global data flow <../ql-training/cpp/global-data-flow-cpp.html>`__–an introduction to analyzing global data flow in C/C++ using CodeQL. -- `Analyzing control flow: CodeQL for C/C++ <../ql-training/cpp/control-flow-cpp.html>`__–an introduction to analyzing control flow in C/C++ using CodeQL. - -CodeQL and variant analysis for Java -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- `Introduction to variant analysis: CodeQL for Java <../ql-training/java/intro-ql-java.html>`__–an introduction to variant analysis and CodeQL for Java programmers. -- `Example: Query injection <../ql-training/java/query-injection-java.html>`__–an example of iterative query development to find unsanitized SPARQL injections in a Java project. -- `Program representation: CodeQL for Java <../ql-training/java/program-representation-java.html>`__–information on how CodeQL analysis represents Java programs. -- `Introduction to local data flow <../ql-training/java/data-flow-java.html>`__–an introduction to analyzing local data flow in Java using CodeQL, including an example demonstrating how to develop a query to find a real CVE. -- `Exercise: Apache Struts <../ql-training/java/apache-struts-java.html>`__–an example demonstrating how to develop a data flow query. -- `Introduction to global data flow <../ql-training/java/global-data-flow-java.html>`__–an introduction to analyzing global data flow in Java using CodeQL. - -Further reading -~~~~~~~~~~~~~~~ - -- `GitHub Security Lab `__ diff --git a/docs/language/learn-ql/terminology-note.rst b/docs/language/learn-ql/terminology-note.rst deleted file mode 100644 index 211e4722112..00000000000 --- a/docs/language/learn-ql/terminology-note.rst +++ /dev/null @@ -1,27 +0,0 @@ -Recent terminology changes -=========================== - -We recently started using new terminology to make it clearer to users what our products do. -This note gives some information about what has changed. - -CodeQL ------- - -CodeQL is the code analysis platform formerly known as QL. -CodeQL treats code as data, and CodeQL analysis is based on running queries against your code to check for errors and find bugs and vulnerabilities. -The CodeQL product includes the tools, scripts, queries, and libraries used in CodeQL analysis. - -QL ---- - -Previously we used the term QL to refer to the whole code analysis platform, which has been renamed CodeQL. -The name QL now only refers to the query language that powers CodeQL analysis. - -The CodeQL queries and libraries used to analyze source code are written in QL. -These queries and libraries are open source, and can be found in the `CodeQL repository `__. -QL is a general-purpose, object-oriented language that can be used to query any kind of data. - -CodeQL databases ----------------- - -QL snapshots have been renamed CodeQL databases. `CodeQL databases `__ contain relational data created and analyzed using CodeQL. They are the equivalent of QL snapshots, but have been optimized for use with the CodeQL tools. diff --git a/docs/language/reusables/codeql-cli-overview.rst b/docs/language/reusables/codeql-cli-overview.rst deleted file mode 100644 index 31a75096b43..00000000000 --- a/docs/language/reusables/codeql-cli-overview.rst +++ /dev/null @@ -1,3 +0,0 @@ -The CodeQL command-line interface (CLI) is used to create databases for -security research. You can query CodeQL databases directly from the command line -or using the Visual Studio Code extension. diff --git a/docs/language/reusables/download-lgtm-database.rst b/docs/language/reusables/download-lgtm-database.rst deleted file mode 100644 index 11652d6512a..00000000000 --- a/docs/language/reusables/download-lgtm-database.rst +++ /dev/null @@ -1,6 +0,0 @@ -To download a database from LGTM.com: - -#. Log in to `LGTM.com `__. -#. Find a project you're interested in and display the Integrations tab (for example, `Apache Kafka `__). -#. Scroll to the **CodeQL databases for local analysis** section at the bottom of the page. -#. Download databases for the languages that you want to explore. \ No newline at end of file diff --git a/docs/language/reusables/extractors.rst b/docs/language/reusables/extractors.rst deleted file mode 100644 index 9076f7a768d..00000000000 --- a/docs/language/reusables/extractors.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. list-table:: - :header-rows: 1 - :widths: 50 50 - - * - Language - - Identifier - * - C/C++ - - ``cpp`` - * - C# - - ``csharp`` - * - Go - - ``go`` - * - Java - - ``java`` - * - JavaScript/TypeScript - - ``javascript`` - * - Python - - ``python`` \ No newline at end of file diff --git a/docs/language/reusables/index-files-note.rst b/docs/language/reusables/index-files-note.rst deleted file mode 100644 index aad0637cbe1..00000000000 --- a/docs/language/reusables/index-files-note.rst +++ /dev/null @@ -1,8 +0,0 @@ -The CodeQL CLI currently extracts data from additional, external files in a -different way to the legacy QL tools. For example, when you run ``codeql database create`` -the CodeQL CLI extracts data from some relevant XML files for Java and C#, but not -for the other supported languages, such as JavaScript. This means that CodeQL databases -created using the CodeQL CLI may be slightly different from those obtained from LGTM.com or -created using the legacy QL command-line tools. As such, analysis results generated from -databases created using the CodeQL CLI may also differ from those generated from -databases obtained from elsewhere. \ No newline at end of file diff --git a/docs/language/reusables/license-note.rst b/docs/language/reusables/license-note.rst deleted file mode 100644 index ad440e3bfa6..00000000000 --- a/docs/language/reusables/license-note.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. pull-quote:: License notice - - If you don't have an Enterprise license then, by installing this product, you are agreeing to the - `GitHub CodeQL Terms and Conditions `__. - - GitHub CodeQL is licensed on a per-user basis. Under the license restrictions, - you can CodeQL to perform the following tasks: - - - To perform academic research. - - To demonstrate the software. - - To test CodeQL queries that are released under an OSI-approved - License to confirm that new versions of those queries continue to - find the right vulnerabilities. - - where "OSI-approved License" means an Open Source Initiative - (OSI)-approved open source software license. - - If you are working with an Open Source Codebase (that is, a codebase that is - released under an OSI-approved License) you can also use CodeQL for the following tasks: - - - To perform analysis of the Open Source Codebase. - - If the Open Source Codebase is hosted and maintained on - GitHub.com, to generate CodeQL databases for or during automated - analysis, continuous integration, or continuous delivery. - - CodeQL can't be used for automated analysis, continuous integration or - continuous delivery, whether as part of normal software engineering processes - or otherwise, except in the express cases set forth herein. For these uses, - contact the `sales team `__. diff --git a/docs/language/reusables/test-qlpack.rst b/docs/language/reusables/test-qlpack.rst deleted file mode 100644 index fe2fc5f4199..00000000000 --- a/docs/language/reusables/test-qlpack.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. code-block:: yaml - - name: my-query-tests - version: 0.0.0 - libraryPathDependencies: my-custom-queries - extractor: java - tests: . - -This ``qlpack.yml`` file states that ``my-query-tests`` depends on -``my-custom-queries``. It also declares that the CLI should use the -Java ``extractor`` when creating test databases. -Supported from CLI 2.1.0 onward, the ``tests: .`` line declares -that all ``.ql`` files in the pack should be -run as tests when ``codeql test run`` is run with the -``--strict-test-discovery`` option. diff --git a/docs/language/reusables/threads-query-execution.rst b/docs/language/reusables/threads-query-execution.rst deleted file mode 100644 index 657d62c9d55..00000000000 --- a/docs/language/reusables/threads-query-execution.rst +++ /dev/null @@ -1,3 +0,0 @@ -``--threads``: optionally, the number of threads to use when running queries. -The default option is ``1``. You can specify more threads to speed up query -execution. Specifying ``0`` matches the number of threads to the number of logical processors. \ No newline at end of file