summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorda-woods <dw-git@d-woods.co.uk>2021-08-31 22:08:22 +0100
committerGitHub <noreply@github.com>2021-08-31 23:08:22 +0200
commit58d6a7d7f2be284638e62724a43b0ecc80d31cf9 (patch)
tree4de5507d323bd4e2a931aa545a41e10c67ded146
parentbad93a3ab3b698ec4106dbf03e1a103e2582d003 (diff)
downloadcython-58d6a7d7f2be284638e62724a43b0ecc80d31cf9.tar.gz
Update docs to recommend using MSVC on Windows (GH-4345)
See https://github.com/cython/cython/pull/4142#issuecomment-831464115 I don't think MinGW has worked since around Python 3.4 (but I'm not completely confident in that) while I know that MSVC does work. Therefore we should recommend that.
-rw-r--r--docs/src/quickstart/install.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/src/quickstart/install.rst b/docs/src/quickstart/install.rst
index ce4deeab8..8b5f4c350 100644
--- a/docs/src/quickstart/install.rst
+++ b/docs/src/quickstart/install.rst
@@ -22,13 +22,16 @@ according to the system used:
XCode, which can be retrieved from the Mac OS X's install DVDs or
from https://developer.apple.com/.
- - **Windows** A popular option is to use the open source MinGW (a
+ - **Windows** The CPython project recommends building extension modules
+ (including Cython modules) with the same compiler that Python was
+ built with. This is usually a specific version of Microsoft Visual
+ C/C++ (MSVC) - see https://wiki.python.org/moin/WindowsCompilers.
+ MSVC is the only compiler that Cython is currently tested with on
+ Windows. A possible alternative is the open source MinGW (a
Windows distribution of gcc). See the appendix for instructions for
setting up MinGW manually. Enthought Canopy and Python(x,y) bundle
MinGW, but some of the configuration steps in the appendix might
- still be necessary. Another option is to use Microsoft Visual C/C++
- (MSVC). One must then use the same version which the installed Python was
- compiled with.
+ still be necessary.
.. dagss tried other forms of ReST lists and they didn't look nice
.. with rst2latex.