| Age | Commit message (Collapse) | Author |
|---|
|
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
The link errors were found with linkcheck command:
(line 1958) broken https://docs.python.org/3/library/re.html#re - Anchor 're' not found
(line 713) broken http://docs.python.org/3/library/re.html#re - Anchor 're' not found
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Review all pages, and fix up for formatting which was not covered by
pandoc, such as some links and code block sections.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
This patch fixes a handful of remaining warnings reported by Sphinx.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
For some notes with links, the links were lost during the pandoc
conversion.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Since we converted the list of variables into a Sphinx glossary, the
automatic conversion from Pandoc does not produce proper links. We fix
them up using a Python regexp.
Similarly some http links were not converted correctly, and can also
be fixed up with a regexp.
This patch was generated by running the following regexp:
line = re.sub("` <(https?://.*)>`__",
"\\1",
line)
line = re.sub("`+(\w+)`* <#var-bb-\\1>`__",
":term:`\\1`",
line)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
This commit is autogenerated pandoc to generate an inital set
of reST files based on DocBook XML files.
A .rst file is generated for each .xml files in all manuals with this
command:
cd <manual>
for i in *.xml; do \
pandoc -f docbook -t rst --shift-heading-level-by=-1 \
$i -o $(basename $i .xml).rst \
done
The conversion was done with: pandoc 2.9.2.1-91 (Arch Linux).
Also created an initial top level index file for each document, and
added all 'books' to the top leve index.rst file.
The YP manuals layout is organized as:
Book
Chapter
Section
Section
Section
Sphinx uses section headers to create the document structure.
ReStructuredText defines sections headers like that:
To break longer text up into sections, you use section headers. These
are a single line of text (one or more words) with adornment: an
underline alone, or an underline and an overline together, in dashes
"-----", equals "======", tildes "~~~~~~" or any of the
non-alphanumeric characters = - ` : ' " ~ ^ _ * + # < > that you feel
comfortable with. An underline-only adornment is distinct from an
overline-and-underline adornment using the same character. The
underline/overline must be at least as long as the title text. Be
consistent, since all sections marked with the same adornment style
are deemed to be at the same level:
Let's define the following convention when converting from Docbook:
Book => overline === (Title)
Chapter => overline *** (1.)
Section => ==== (1.1)
Section => ---- (1.1.1)
Section => ~~~~ (1.1.1.1)
Section => ^^^^ (1.1.1.1.1)
During the conversion with pandoc, we used --shift-heading-level=-1 to
convert most of DocBook headings automatically. However with this
setting, the Chapter header was removed, so I added it back
manually. Without this setting all headings were off by one, which was
more difficult to manually fix.
At least with this change, we now have the same TOC with Sphinx and
DocBook.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
Nicolas Dechesne