diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/README | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/documentation/README b/documentation/README index 10b46de3e6..123812dcac 100644 --- a/documentation/README +++ b/documentation/README | |||
| @@ -113,13 +113,18 @@ documentation with Python3. | |||
| 113 | Sphinx might be available in your Linux distro packages repositories, | 113 | Sphinx might be available in your Linux distro packages repositories, |
| 114 | however it is not recommended to use distro packages, as they might be | 114 | however it is not recommended to use distro packages, as they might be |
| 115 | old versions, especially if you are using an LTS version of your | 115 | old versions, especially if you are using an LTS version of your |
| 116 | distro. The recommended method to install Sphinx and all required | 116 | distro. The recommended method to install the latest versions of Sphinx |
| 117 | dependencies is to use the Python Package Index (pip). | 117 | and of its required dependencies is to use the Python Package Index (pip). |
| 118 | 118 | ||
| 119 | To install all required packages run: | 119 | To install all required packages run: |
| 120 | 120 | ||
| 121 | $ pip3 install sphinx sphinx_rtd_theme pyyaml | 121 | $ pip3 install sphinx sphinx_rtd_theme pyyaml |
| 122 | 122 | ||
| 123 | To make sure you always have the latest versions of such packages, you | ||
| 124 | should regularly run the same command with an added "--upgrade" option: | ||
| 125 | |||
| 126 | $ pip3 install --upgrade sphinx sphinx_rtd_theme pyyaml | ||
| 127 | |||
| 123 | Also install the "inkscape" package from your distribution. | 128 | Also install the "inkscape" package from your distribution. |
| 124 | Inkscape is need to convert SVG graphics to PNG (for EPUB | 129 | Inkscape is need to convert SVG graphics to PNG (for EPUB |
| 125 | export) and to PDF (for PDF export). | 130 | export) and to PDF (for PDF export). |
