1- QL language documentation
2- #########################
1+ CodeQL documentation
2+ ####################
33
44Overview
55********
66
7- The QL language documentation is written in reStructuredText and converted to
7+ The CodeQL documentation in this repository is written in reStructuredText and converted to
88HTML for manual publication on `help.semmle.com <https://help.semmle.com >`__ using Sphinx.
99
1010For more information on writing in reStructuredText,
@@ -15,13 +15,13 @@ For more information on Sphinx, see https://www.sphinx-doc.org.
1515Project structure
1616*****************
1717
18- The QL language documentation currently consists of the following Sphinx projects:
18+ The documentation currently consists of the following Sphinx projects:
1919
20- - ``learn-ql ``–help topics to help you learn the QL language and write queries
21- - ``ql-handbook ``–a user-friendly guide to the QL language
20+ - ``learn-ql ``–help topics to help you learn CodeQL and write queries
21+ - ``ql-handbook ``–a user-friendly guide to the QL language, which underlies CodeQL analysis
2222- ``ql-spec ``–formal descriptions of the QL language and QLDoc comments
23- - ``support ``–the languages and frameworks currently supported in QL analysis
24- - ``ql-training ``–source files for the QL training and variant analysis examples slide decks
23+ - ``support ``–the languages and frameworks currently supported in CodeQL analysis
24+ - ``ql-training ``–source files for the CodeQL training and variant analysis examples slide decks
2525
2626Each project contains:
2727
@@ -34,20 +34,20 @@ Shared configuration values are specified in ``global-conf.py``, which is found
3434in the ``global-sphinx-files `` directory.
3535This directory also contains any other files, such as templates and stylesheets,
3636that are used by multiple projects.
37- Images used in the QL documentation are located in the ``images `` directory.
37+ Images used in the documentation are located in the ``images `` directory.
3838
3939The ``ql-training `` project contains the source files, themes, and static files
40- used to generate the QL training and variant analysis presentations.
40+ used to generate the CodeQL training and variant analysis presentations.
4141It uses a different configuration from the other projects, and is built using an
4242extension specifically designed for HTML slide shows.
4343For more information, see
44- **Building and previewing the QL training presentations ** below.
44+ **Building and previewing the CodeQL training presentations ** below.
4545
4646
47- Building and previewing the QL language documentation
48- *****************************************************
47+ Building and previewing the CodeQL documentation
48+ ************************************************
4949
50- To build and preview the QL documentation and QL training presentations locally, you need to
50+ To build and preview the documentation and training presentations locally, you need to
5151install Sphinx 1.7.9. More recent versions of Sphinx do not work with hieroglyph,
5252the Sphinx extension that we use to generate HTML slides, as explained below.
5353For installation options, see https://github.com/sphinx-doc/sphinx.
@@ -85,15 +85,15 @@ Visual Studio Code has an extension that can be used to preview Sphinx-generated
8585output alongside ``.rst `` source code in your IDE. For more information, see the
8686`Visual Studio Marketplace <https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext >`__.
8787
88- Building and previewing the QL training presentations
89- *****************************************************
88+ Building and previewing the CodeQL training presentations
89+ *********************************************************
9090
91- To build the QL training presentations, you need to install a Sphinx extension
91+ To build the training presentations, you need to install a Sphinx extension
9292called `hieroglyph <https://github.com/nyergler/hieroglyph >`__.
9393You also need to install `graphviz <https://graphviz.gitlab.io/download/ >`__, which
9494is used to generate graphs on some slides.
9595
96- After installing hieroglyph and graphviz, you can build the QL training presentations by running
96+ After installing hieroglyph and graphviz, you can build the training presentations by running
9797``sphinx-build ``, specifying the ``slides `` builder. For example
9898
9999.. code ::
@@ -106,10 +106,10 @@ the ``ql-training`` source directory.
106106For more information about creating slides for QL training and variant analysis
107107examples, see the `template slide deck <https://github.com/Semmle/ql/blob/master/docs/language/ql-training/template.rst >`__.
108108
109- Viewing the current version of the QL language documentation
110- ************************************************************
109+ Viewing the current version of the CodeQL documentation
110+ *******************************************************
111111
112- The QL language documentation for the most recent Semmle release is
112+ The documentation for the most recent Semmle release is
113113published to `help.semmle.com <https://help.semmle.com >`__.
114- There, you can also find the documentation for QL for Eclipse,
115- QL for Visual Studio, QL command-line tools , and LGTM Enterprise.
114+ There, you can also find the documentation for the CodeQL CLI,
115+ the CodeQL extension for Visual Studio Code , and LGTM Enterprise.
0 commit comments