Reorganize the setup.rst page. #412
Conversation
|
|
||
| The core CPython interpreter only needs a C compiler to be built; if | ||
| you get compile errors with a C89 or C99-compliant compiler, please `open a | ||
| bug report <https://bugs.python.org>`_. |
There was a problem hiding this comment.
This part has been moved below.
|
|
||
| Build dependencies | ||
| ------------------ | ||
| UNIX |
There was a problem hiding this comment.
This should include both Linux and macOS.
| UNIX | ||
| ---- | ||
| If you want to install these optional dependencies, consult the | ||
| :ref:`build-dependencies` section below. |
There was a problem hiding this comment.
Is the terminology correct here (and elsewhere)?
AFAIU the dependencies, are required to build extension modules (or simply extensions). The dependencies can be installed (by using yum/apt/etc) and built (indirectly, by make).
The section below covers installing for Linux, and both installing and building (since different flags are required by configure) for macOS.
| _tkinter _uuid readline | ||
| zlib | ||
| To find the necessary bits, look in setup.py in detect_modules() | ||
| for the module's name. |
There was a problem hiding this comment.
I added this block to show clearly where the missing extensions are listed, and pointed out that this is expected and should not be considered an error (I've seen people being confused by this message before).
|
|
||
|
|
||
| Clang | ||
| ''''' |
There was a problem hiding this comment.
This is now nested under the UNIX section.
| .. _build-dependencies: | ||
|
|
||
| Install dependencies | ||
| ==================== |
There was a problem hiding this comment.
This is now a new top-level section, that covers installing dependencies.
Since it also explains how to buiild them for macOS, perhaps the title should be changed to Install and build dependencies
| ``configure`` and ``make`` (if available for your OS). | ||
| Otherwise the build failed and thus should be fixed (at least with a bug being | ||
| filed on the `issue tracker`_). | ||
|
|
There was a problem hiding this comment.
I removed this part because it was duplicated from above. People that reach this point should have already read and know what make does.
| ---- | ||
|
|
||
| The basic steps for building Python for development is to configure it and | ||
| then compile it. |
There was a problem hiding this comment.
This part has been moved to the top.
|
|
||
| .. _deps-on-linux: | ||
|
|
||
| Linux |
There was a problem hiding this comment.
This used to be UNIX, but it seems to me that it's Linux-specific, since macOS is covered later.
Am I missing something?
There was a problem hiding this comment.
Thanks @ezio-melotti. This looks great. One small typo. Feel free to merge.
* Reorganize the setup.rst page. * Fix typo.
This PR reorganizes the setup.rst page: