Skip to content

Commit 28fece0

Browse files
author
Felicity Chapman
authored
Merge pull request #1906 from jf205/readme-updates
docs: update readme following recent project changes
2 parents 2283195 + 54342a6 commit 28fece0

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/language/README.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ The QL language documentation currently consists of the following Sphinx project
2121
- ``ql-handbook``–a user-friendly guide to the QL language
2222
- ``ql-spec``–formal descriptions of the QL language and QLDoc comments
2323
- ``support``–the languages and frameworks currently supported in QL analysis
24-
- ``training``–QL for variant analysis training material
25-
- ``ql-training-rst``–QL for variant analysis slide shows
24+
- ``ql-training``–source files for the QL training and variant analysis examples slide decks
2625

2726
Each project contains:
2827

@@ -37,8 +36,8 @@ This directory also contains any other files, such as templates and stylesheets,
3736
that are used by multiple projects.
3837
Images used in the QL documentation are located in the ``images`` directory.
3938

40-
The ``ql-training-rst`` project contains the source files, themes, and static files
41-
used to generate the QL training presentations.
39+
The ``ql-training`` project contains the source files, themes, and static files
40+
used to generate the QL training and variant analysis presentations.
4241
It uses a different configuration from the other projects, and is built using an
4342
extension specifically designed for HTML slide shows.
4443
For more information, see
@@ -72,11 +71,13 @@ For example, to generate the HTML output for a project in the
7271
7372
Add the ``-W`` flag to turn *warnings* into *errors* during the build process.
7473
You can use errors reported during the build to debug problems in your source
75-
code, such as broken internal links and malformed tables.
74+
code, such as broken internal links and malformed tables. You can also check
75+
external links using Sphinx's `external link builder
76+
<http://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.linkcheck.CheckExternalLinksBuilder>`__.
7677

7778
Add the ``-a`` flag to regenerate all output files. By default, only files that
7879
have changed are rebuilt.
79-
80+
8081
Using the reStructuredText Extension for Visual Studio Code
8182
-----------------------------------------------------------
8283

@@ -98,8 +99,10 @@ After installing hieroglyph, you can build the QL training presentations by runn
9899
sphinx-build -b slides . <slides-output>
99100
100101
generates html slide shows in the ``<slides-output>`` directory when run from
101-
the ``ql-training-rst`` source directory.
102+
the ``ql-training`` source directory.
102103

104+
For more information about creating slides for QL training and variant analysis
105+
examples, see the `template slide deck <https://github.com/Semmle/ql/blob/master/docs/language/ql-training/template.rst>`__.
103106

104107
Viewing the current version of the QL language documentation
105108
************************************************************

0 commit comments

Comments
 (0)