Improve docs about compilation toolchain requirements

Add mention about installing Python 3-flavored SCons with pip for Linux distros which still only provide a Python 2 build (e.g. Ubuntu 18.04).
2026-01-04 14:11:02 +03:00 · 2020-03-25 14:57:53 +01:00
parent d40be695f1
commit ac5aa6cd1e
9 changed files with 43 additions and 42 deletions
--- a/README.md
+++ b/README.md
@@ -42,7 +42,7 @@ Similarly, you can include attachments (like assets as support material for a tu

 ## Building with Sphinx

-To build the HTML website (or any other format supported by Sphinx, like PDF, EPUB or LaTeX), you need to install [Sphinx](https://www.sphinx-doc.org/) >= 1.3 as well as (for the HTML) the [readthedocs.org theme](https://github.com/snide/sphinx_rtd_theme). Only the Python 3 flavor was tested, though the Python 2 versions might work too.
+To build the HTML website (or any other format supported by Sphinx, like PDF, EPUB or LaTeX), you need to install [Sphinx](https://www.sphinx-doc.org/) >= 1.3 as well as (for the HTML) the [readthedocs.org theme](https://github.com/snide/sphinx_rtd_theme).
 You also need to install the Sphinx extensions defined in `requirements.txt`.

 Those tools are best installed using [pip](https://pip.pypa.io), Python's module installer. The Python 3 version might be provided (on Linux distros) as `pip3` or `python3-pip`. You can then run:
--- a/development/compiling/compiling_for_android.rst
+++ b/development/compiling/compiling_for_android.rst
@@ -21,18 +21,19 @@ Requirements

 For compiling under Windows, Linux or macOS, the following is required:

-  `Python 3.5+ <https://www.python.org/downloads/>`_
-  `SCons <https://scons.org/pages/download.html>`_ build system
-  `Android SDK <https://developer.android.com/studio/#command-tools>`_ (command-line tools are sufficient)
+-  `Python 3.5+ <https://www.python.org/downloads/>`_.
+-  `SCons 3.0+ <https://scons.org/pages/download.html>`_ build system.
+-  `Android SDK <https://developer.android.com/studio/#command-tools>`_
+   (command-line tools are sufficient).

-   -  Required SDK components will be automatically installed by Gradle (except the NDK)
+   -  Required SDK components will be automatically installed by Gradle (except the NDK).

-  `Android NDK <https://developer.android.com/ndk/downloads/>`_ r17 or later
-  Gradle (will be downloaded and installed automatically if missing)
-  JDK 8 (either OpenJDK or Oracle JDK)
+-  `Android NDK <https://developer.android.com/ndk/downloads/>`_ r17 or later.
+-  Gradle (will be downloaded and installed automatically if missing).
+-  JDK 8 (either OpenJDK or Oracle JDK).

-   -  JDK 9 or later are not currently supported
-   -  You can download a build from `ojdkbuild <https://github.com/ojdkbuild/ojdkbuild>`_
+   -  JDK 9 or later are not currently supported.
+   -  You can download a build from `ojdkbuild <https://github.com/ojdkbuild/ojdkbuild>`_.

 .. seealso:: For a general overview of SCons usage for Godot, see
             :ref:`doc_introduction_to_the_buildsystem`.
--- a/development/compiling/compiling_for_ios.rst
+++ b/development/compiling/compiling_for_ios.rst
@@ -8,8 +8,8 @@ Compiling for iOS
 Requirements
 ------------

-  SCons (you can get it from macports, you should be able to run
-   ``scons`` in a terminal when installed)
+-  SCons 3.0+ (you can install it via Homebrew or Macports, you should be able
+   to run ``scons`` in a terminal when installed).
 -  Xcode 10.0 (or later) with the iOS (10.0) SDK and the command line tools.

 .. seealso:: For a general overview of SCons usage for Godot, see
--- a/development/compiling/compiling_for_osx.rst
+++ b/development/compiling/compiling_for_osx.rst
@@ -10,8 +10,8 @@ Requirements

 For compiling under macOS, the following is required:

- `Python 3.5+ <https://www.python.org>`_
- `SCons <https://www.scons.org>`_ build system.
+- `Python 3.5+ <https://www.python.org>`_.
+- `SCons 3.0+ <https://www.scons.org>`_ build system.
 - `Xcode <https://apps.apple.com/us/app/xcode/id497799835>`_
  (or the more lightweight Command Line Tools for Xcode).
 - *Optional* - `yasm <https://yasm.tortall.net/>`_ (for WebM SIMD optimizations).
--- a/development/compiling/compiling_for_uwp.rst
+++ b/development/compiling/compiling_for_uwp.rst
@@ -8,10 +8,9 @@ Compiling for Universal Windows Platform
 Requirements
 ------------

-  SCons (see :ref:`doc_compiling_for_windows` for more details).
-  Visual Studio 2015 Update 2. It may work with earlier versions. See
-   :ref:`doc_compiling_for_windows` about the caveats of installing it
-   and the various prompts.
+-  SCons 3.0+ (see :ref:`doc_compiling_for_windows` for more details).
+-  Visual Studio 2017 or later. See :ref:`doc_compiling_for_windows` about the
+   caveats of installing it and the various prompts.
 -  Windows 10 SDK (can be selected in Visual Studio installation).
 -  `ANGLE source <https://github.com/Microsoft/angle>`__. Use the
   ``ms_master`` (default) branch. Keep it in a path without spaces to
@@ -21,7 +20,8 @@ Requirements
          ``ms_master`` branch has been cleared out.
          
          As a temporary workaround however, it is still possible to
-          download an older state of the source code via commit `c61d048 <https://github.com/microsoft/angle/tree/c61d0488abd9663e0d4d2450db7345baa2c0dfb6>`__.
+          download an older state of the source code via commit
+          `c61d048 <https://github.com/microsoft/angle/tree/c61d0488abd9663e0d4d2450db7345baa2c0dfb6>`__.
          
          This page will eventually be updated in the future to reflect
          the new build instructions.
--- a/development/compiling/compiling_for_web.rst
+++ b/development/compiling/compiling_for_web.rst
@@ -10,11 +10,9 @@ Requirements

 To compile export templates for the Web, the following is required:

-  `Emscripten 1.38.27+ <http://kripken.github.io/emscripten-site>`__: If the version available
-   per package manager is not recent enough, the best alternative is to install
-   using the `Emscripten SDK <http://kripken.github.io/emscripten-site/docs/getting_started/downloads.html>`__
-  `Python 3.5+ <https://www.python.org/>`__
-  `SCons <https://www.scons.org>`__ build system
+-  `Emscripten 1.39.0+ <https://emscripten.org>`__.
+-  `Python 3.5+ <https://www.python.org/>`__.
+-  `SCons 3.0+ <https://www.scons.org>`__ build system.

 .. seealso:: For a general overview of SCons usage for Godot, see
             :ref:`doc_introduction_to_the_buildsystem`.
--- a/development/compiling/compiling_for_windows.rst
+++ b/development/compiling/compiling_for_windows.rst
@@ -11,14 +11,14 @@ Requirements
 For compiling under Windows, the following is required:

 - `Visual Studio Community <https://www.visualstudio.com/vs/community/>`_,
-  version 2015 (14.0) or later. VS 2019 is recommended.
+  version 2017 or later. VS 2019 is recommended.
  **Make sure to read "Installing Visual Studio caveats" below or you
  will have to run/download the installer again.**
- MinGW-w64 with GCC can be used as an alternative to Visual Studio.
-  Be sure to install/configure it to use the ``posix`` thread model.
- `Python 3.5+ <https://www.python.org/downloads/windows/>`_
- `SCons <https://www.scons.org>`_ build system. If using Visual Studio 2019,
-  you *must* have SCons 3.1.1 or later.
+- `MinGW-w64 <http://mingw-w64.org/>`_ with GCC can be used as an alternative to
+  Visual Studio. Be sure to install/configure it to use the ``posix`` thread model.
+- `Python 3.5+ <https://www.python.org/downloads/windows/>`_.
+- `SCons 3.0 <https://www.scons.org>`_ build system. If using Visual Studio 2019,
+  you need at least SCons 3.1.1.
 - *Optional* - `yasm <https://yasm.tortall.net/>`_ (for WebM SIMD optimizations)

 .. note:: If you have `Scoop <https://scoop.sh/>`_ installed, you can easily
--- a/development/compiling/compiling_for_x11.rst
+++ b/development/compiling/compiling_for_x11.rst
@@ -11,16 +11,19 @@ Requirements
 For compiling under Linux or other Unix variants, the following is
 required:

-  GCC or Clang
-  Python 3.5+
-  SCons build system (3.0 or later for Python 3)
-  pkg-config (used to detect the dependencies below)
-  X11, Xcursor, Xinerama, Xi and XRandR development libraries
-  MesaGL development libraries
-  ALSA development libraries
-  PulseAudio development libraries
-  *Optional* - libudev (build with ``udev=yes``)
-  *Optional* - yasm (for WebM SIMD optimizations)
+-  GCC 7+ or Clang 6+.
+-  Python 3.5+.
+-  SCons 3.0+ build system. If your Linux distribution only provides a Python 2
+   build of SCons, install the Python 3 flavor with ``pip3 install --user scons``.
+   You may also want to uninstall the distribution ``scons`` package to ensure
+   that the pip-installed one takes precedence.
+-  pkg-config (used to detect the dependencies below).
+-  X11, Xcursor, Xinerama, Xi and XRandR development libraries.
+-  MesaGL development libraries.
+-  ALSA development libraries.
+-  PulseAudio development libraries.
+-  *Optional* - libudev (build with ``udev=yes``).
+-  *Optional* - yasm (for WebM SIMD optimizations).

 .. seealso:: For a general overview of SCons usage for Godot, see
             :ref:`doc_introduction_to_the_buildsystem`.
--- a/getting_started/workflow/export/exporting_for_web.rst
+++ b/getting_started/workflow/export/exporting_for_web.rst
@@ -17,8 +17,7 @@ in the user's browser.
               ``file://`` protocol. To get around this, use a local server.

               .. tip:: Python offers an easy method to start a local server.
-                        Use ``python -m SimpleHTTPServer`` with Python 2 or
-                        ``python -m http.server`` with Python 3 to serve the
+                        Use ``python -m http.server`` with Python 3 to serve the
                        current working directory at ``http://localhost:8000``.

 WebGL 2