Skip to content
This repository was archived by the owner on Aug 5, 2024. It is now read-only.

Commit 3d00d70

Browse files
authored
Merge pull request #67 from swift-nav/fixes
docs: added new warnings page
2 parents a6b20c0 + 4f3fd52 commit 3d00d70

File tree

10 files changed

+1539
-3
lines changed

10 files changed

+1539
-3
lines changed

doc/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
PAGES := index.html reference.html guide.html tutorials.html
1+
PAGES := index.html reference.html guide.html tutorials.html warnings.html
22

33
index.html: index.rst template.txt
44
rst2html.py $< $@ --math-output=MathJax --template=template.txt --stylesheet=stylesheets/normalize.css,stylesheets/pygment_trac.css,stylesheets/style.css --no-toc-backlinks --section-numbering

doc/guide.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1249,6 +1249,7 @@ <h1 class="title">Plover User Guide</h1>
12491249
<li><a href="guide.html">Guide</a></li>
12501250
<li><a href="tutorials.html">Tutorials</a></li>
12511251
<li><a href="reference.html">Reference</a></li>
1252+
<li><a href="warnings.html">Warnings</a></li>
12521253
</ul>
12531254
</header>
12541255
</div>

doc/index.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1236,6 +1236,7 @@ <h2 class="subtitle" id="high-level-embedded-linear-algebra-programming">High-le
12361236
<li><a href="guide.html">Guide</a></li>
12371237
<li><a href="tutorials.html">Tutorials</a></li>
12381238
<li><a href="reference.html">Reference</a></li>
1239+
<li><a href="warnings.html">Warnings</a></li>
12391240
</ul>
12401241
</header>
12411242
</div>
@@ -1261,6 +1262,8 @@ <h1>Documentation</h1>
12611262
programming algorithms and applications in Plover.</li>
12621263
<li>The <a class="reference external" href="reference.html">Plover Language Reference</a> gives a more
12631264
in-depth treatment of the language itself.</li>
1265+
<li><a class="reference external" href="warnings.html">Notable Differences</a> enumerates some notable differences
1266+
from related languages and corner cases to be aware of.</li>
12641267
</ul>
12651268
</div>
12661269
<div class="section" id="in-the-real-world">

doc/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ The Plover documentation is split into the following parts:
3131
programming algorithms and applications in Plover.
3232
- The `Plover Language Reference <reference.html>`_ gives a more
3333
in-depth treatment of the language itself.
34+
- `Notable Differences <warnings.html>`_ enumerates some notable differences
35+
from related languages and corner cases to be aware of.
3436

3537

3638
In the real world

doc/reference.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1250,6 +1250,7 @@ <h1 class="title">Plover Language Reference</h1>
12501250
<li><a href="guide.html">Guide</a></li>
12511251
<li><a href="tutorials.html">Tutorials</a></li>
12521252
<li><a href="reference.html">Reference</a></li>
1253+
<li><a href="warnings.html">Warnings</a></li>
12531254
</ul>
12541255
</header>
12551256
</div>
@@ -2471,7 +2472,7 @@ <h1>Language Proposals</h1>
24712472
<tr><th class="docinfo-name">Authors:</th>
24722473
<td>Scott Kovach
24732474
<br />Kyle Miller</td></tr>
2474-
<tr class="field"><th class="docinfo-name">Modified:</th><td class="field-body">August 2015</td>
2475+
<tr class="field"><th class="docinfo-name">Modified:</th><td class="field-body">June 2016</td>
24752476
</tr>
24762477
</tbody>
24772478
</table>

doc/reference.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
===========================
44

55
:Authors: Scott Kovach, Kyle Miller
6-
:Modified: August 2015
6+
:Modified: June 2016
77

88
Overview
99
========

doc/template.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ id: '{\\mathrm{id}}'
4343
<li><a href="guide.html">Guide</a></li>
4444
<li><a href="tutorials.html">Tutorials</a></li>
4545
<li><a href="reference.html">Reference</a></li>
46+
<li><a href="warnings.html">Warnings</a></li>
4647
</ul>
4748
</header>
4849
</div>

doc/tutorials.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1250,6 +1250,7 @@ <h1 class="title">Plover Tutorials</h1>
12501250
<li><a href="guide.html">Guide</a></li>
12511251
<li><a href="tutorials.html">Tutorials</a></li>
12521252
<li><a href="reference.html">Reference</a></li>
1253+
<li><a href="warnings.html">Warnings</a></li>
12531254
</ul>
12541255
</header>
12551256
</div>

0 commit comments

Comments
 (0)