Skip to content

Commit 18b51fa

Browse files
Merge branch 'mr/291-enhance-the-details-in-the-materials-readme-about-building-the-slides-locally' into 'master'
Resolve "Enhance the details in the Materials ReadMe about building the slides locally" Closes #291 See merge request feng/training/material!364
2 parents 34f1fc9 + e02197f commit 18b51fa

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,14 +134,23 @@ PDFs of the course material can be generated locally (on your machine). To do th
134134
The following command will generate a PDF for a specific slide:
135135

136136
```
137-
python [LOCAL_PATH]\training_material\pandoc\pandoc_fe.py --source ./[RST_FILE] --output [OUTPUT_FILE] --extension pdf --directories [LOCAL_PATH]\images,[LOCAL_PATH]\training_material\support_files --theme adacore --color adacore --filter [LOCAL_PATH]\training_material\pandoc\beamer_filter.py
137+
python [LOCAL_PATH]\training_material\pandoc\pandoc_fe.py --source [FILENAME] --output [OUTPUT_FILE] --extension pdf --directories [LOCAL_PATH]\images,[LOCAL_PATH]\training_material\support_files --theme adacore --color adacore --filter [LOCAL_PATH]\training_material\pandoc\beamer_filter.py
138138
```
139139

140140
In the above command:
141141

142142
* **[LOCAL_PATH]** should be replaced with the full path containing the “training_material” source folder
143143

144-
* **[RST_FILE]** should be replaced with the full name of the .rst file containing the source that will be generated as slide content (name should include file extension)
144+
* **[FILENAME]** should be replaced with the path to either of the following:
145+
146+
* Name of the .rst file containing the source to generate the PDF file
147+
* Name of a .txt file containing a list of RST files (one per line) for which a single PDF file will be generated
148+
149+
The filename needs to be a path (for Pandoc) so, if it's local, prepend it with "./" or ".\\" (depending on your OS).
150+
151+
For example, to build the standard course (in the repository as "standard_course.txt"), use **--source ./standard_course.txt**.
152+
If you want a PDF of just the polymorphism module, use **--source ./180_polymorphism.rst**. You can also create your own
153+
.txt file to build multiple modules at once (just don't check it in!).
145154

146155
* **[OUTPUT_FILE]** should be replaced with the desired name of the generated PDF (minus the file extension)
147156

0 commit comments

Comments
 (0)