2
0
Fork 0

Tiny fixes to docs

This commit is contained in:
Thomas Touhey 2019-02-11 19:26:46 +01:00
parent 5076d0b800
commit 4dd686e20a
No known key found for this signature in database
GPG Key ID: 2ECEB0517AD947FB
4 changed files with 5 additions and 4 deletions

1
.gitignore vendored
View File

@ -6,3 +6,4 @@ __pycache__
/build
/docs/_build
/venv
/README.html

View File

@ -91,7 +91,7 @@ tag accepts several types of values:
represents the blue component from 0 to 255.
Incomplete composites will be filled by zero on the left (e.g. ``#0000F``
is equivalent to ``#00000F``), invalid characters such as ``A`` will be
replaced by ``0``s;
replaced by 0s;
- three hex digits codes using ``#`` followed by three hex digits, e.g.
``#123`` which will be translated to ``#112233``;
- ``rgb(<red>, <green>, <blue>)``, where the red, green and blue components

View File

@ -16,7 +16,7 @@ There are a few public members you can define as a tag:
- ``aliases``: the array of names this tag can be accessed as.
Basic tags (the ones with brackets ``[]``) are defined as ``[<name>]``
(e.g. ``[hello]``) and special characters are defined with their symbol,
e.g. ``\```;
e.g. `````;
- ``raw``: the tag's content shall not be interpreted, which is generally
only useful when the content is preprocessed (see below). The default
is ``False`` if there is no preprocess method, and `True` otherwise;

View File

@ -18,7 +18,7 @@ The supported output types are:
- ``html``: `HTML`_ compatible output, requiring some additional style and
script;
- ``lightscript``: `Lightscript`_ Markdown-like language. See
`the Lightscript topic on Planète Casio <Lightscript topic>`_ for
`the Lightscript topic on Planète Casio <Lightscript topic_>`_ for
more information.
The ``tohtml()`` and ``tolightscript()`` can take additional keywords that
@ -38,7 +38,7 @@ The following tweaks are read by the translator and built-in tags:
(e.g. lynx) compatibility, e.g. ``<b>``, ``<i>``, ``<center>``, and
others. Defaults to ``True``.
- ``title_level`` (HTML): level at which to start for titles and subtitles,
e.g. ``h5`` for ``h5`` for titles and ``h6`` for subtitles``.
e.g. ``h5`` for ``h5`` for titles and ``h6`` for subtitles.
An example call would be: