suspect-devices/circuitpython/docs/templates, branch 2.2.0

docs/pyboard: Move info about using Windows from topindex to general.

2017-07-03T05:31:41+00:00

docs/pyboard: Move hardware info into General Info chapter.

2017-07-02T16:23:23+00:00

This makes top-level ToC of the pyboard docs consistent with other ports (consisting of 3 chapters: QuickRef, General Info, and Tutorial). Also, some other minor tweaks applied, like local ToC for General Info and headings mentioning pyboard.

docs/replace.inc: Add |see_cpython|, to xref individual symbols from CPython.

2017-07-02T12:43:12+00:00

The idea is to use it for each symbol in builtins.rst.

docs/library: Add CPython docs xref to each pertinent module.

2017-07-02T12:37:31+00:00

Cross-reference text/link is implemented as RST substitution, so easy to consistently.

docs/conf.py: Add file for global replacements definition.

2017-07-02T12:15:31+00:00

The idea is to allow to define a kind of "macros" for repeatitive text, so all occurrances can be updated in one place. Unfortunately, RST doesn't support replacements with arguments, which limits usefulness of them and should be taken into account.

docs/topindex.html: Fix typo in "Glossary" heading.

2017-07-02T11:29:06+00:00

docs: Add glossary.

2017-07-02T10:47:35+00:00

We have enough terms or references throughout the docs which may be not immediately clear or have some important nuances. Referencing terms in gloassary is the best way to deal with that.

docs: Move topindex.html to templates/ subdir.

2017-07-01T17:30:35+00:00

Later versions of jinja2 need it to be in this subdir, and earlier versions work with it here as well.

docs: Add link to PDF version of docs in sidebar.

2016-06-06T10:37:40+00:00

Requires a link of the form: ///micropython-.pdf

docs: Make the short port names in the port/version sidebar lowercase.

2016-04-28T11:34:59+00:00

To make it neater and simpler.