diff options
Diffstat (limited to 'poky/documentation/README')
| -rw-r--r-- | poky/documentation/README | 32 |
1 files changed, 19 insertions, 13 deletions
diff --git a/poky/documentation/README b/poky/documentation/README index 10b46de3e6..6f6a8ec842 100644 --- a/poky/documentation/README +++ b/poky/documentation/README @@ -113,13 +113,18 @@ documentation with Python3. Sphinx might be available in your Linux distro packages repositories, however it is not recommended to use distro packages, as they might be old versions, especially if you are using an LTS version of your -distro. The recommended method to install Sphinx and all required -dependencies is to use the Python Package Index (pip). +distro. The recommended method to install the latest versions of Sphinx +and of its required dependencies is to use the Python Package Index (pip). To install all required packages run: $ pip3 install sphinx sphinx_rtd_theme pyyaml +To make sure you always have the latest versions of such packages, you +should regularly run the same command with an added "--upgrade" option: + + $ pip3 install --upgrade sphinx sphinx_rtd_theme pyyaml + Also install the "inkscape" package from your distribution. Inkscape is need to convert SVG graphics to PNG (for EPUB export) and to PDF (for PDF export). @@ -170,17 +175,18 @@ The layout of the Yocto Project manuals is organized as follows Book Chapter Section - Section - Section - -Here are the heading styles defined in Sphinx: - - Book => overline === - Chapter => overline *** - Section => ==== - Section => ---- - Section => ^^^^ - Section => """" or ~~~~ + Subsection + Subsubsection + Subsubsubsection + +Here are the heading styles that we use in the manuals: + + Book => overline === + Chapter => overline *** + Section => ==== + Subsection => ---- + Subsubsection => ~~~~ + Subsubsubsection => ^^^^ With this proposal, we preserve the same TOCs between Sphinx and Docbook. |