Skip to content

Commit d783b01

Browse files
authored
Rename README to README.rst and enhance formatting (#2)
Update also the Release Schedule to Python 3.7.
1 parent 4538ddc commit d783b01

File tree

2 files changed

+44
-51
lines changed

2 files changed

+44
-51
lines changed

Makefile.pre.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ SUBDIRSTOO= Include Lib Misc
197197

198198
# Files and directories to be distributed
199199
CONFIGFILES= configure configure.ac acconfig.h pyconfig.h.in Makefile.pre.in
200-
DISTFILES= README ChangeLog $(CONFIGFILES)
200+
DISTFILES= README.rst ChangeLog $(CONFIGFILES)
201201
DISTDIRS= $(SUBDIRS) $(SUBDIRSTOO) Ext-dummy
202202
DIST= $(DISTFILES) $(DISTDIRS)
203203

README renamed to README.rst

Lines changed: 43 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ been removed.
1515
Build Instructions
1616
------------------
1717

18-
On Unix, Linux, BSD, OSX, and Cygwin:
18+
On Unix, Linux, BSD, OSX, and Cygwin::
1919

2020
./configure
2121
make
@@ -24,19 +24,19 @@ On Unix, Linux, BSD, OSX, and Cygwin:
2424

2525
This will install Python as python3.
2626

27-
You can pass many options to the configure script; run "./configure --help" to
28-
find out more. On OSX and Cygwin, the executable is called python.exe;
29-
elsewhere it's just python.
27+
You can pass many options to the configure script; run ``./configure --help`` to
28+
find out more. On OSX and Cygwin, the executable is called ``python.exe``;
29+
elsewhere it's just ``python``.
3030

31-
On Mac OS X, if you have configured Python with --enable-framework, you should
32-
use "make frameworkinstall" to do the installation. Note that this installs the
31+
On Mac OS X, if you have configured Python with ``--enable-framework``, you should
32+
use ``make frameworkinstall`` to do the installation. Note that this installs the
3333
Python executable in a place that is not normally on your PATH, you may want to
34-
set up a symlink in /usr/local/bin.
34+
set up a symlink in ``/usr/local/bin``.
3535

3636
On Windows, see PCbuild/readme.txt.
3737

3838
If you wish, you can create a subdirectory and invoke configure from there.
39-
For example:
39+
For example::
4040

4141
mkdir debug
4242
cd debug
@@ -45,10 +45,10 @@ For example:
4545
make test
4646

4747
(This will fail if you *also* built at the top-level directory.
48-
You should do a "make clean" at the toplevel first.)
48+
You should do a ``make clean`` at the toplevel first.)
4949

50-
To get an optimized build of Python, "configure --enable-optimizations" before
51-
you run make. This sets the default make targets up to enable Profile Guided
50+
To get an optimized build of Python, ``configure --enable-optimizations`` before
51+
you run ``make``. This sets the default make targets up to enable Profile Guided
5252
Optimization (PGO) and may be used to auto-enable Link Time Optimization (LTO)
5353
on some platforms. For more details, see the sections bellow.
5454

@@ -57,7 +57,7 @@ Profile Guided Optimization
5757
---------------------------
5858

5959
PGO takes advantage of recent versions of the GCC or Clang compilers.
60-
If ran, "make profile-opt" will do several steps.
60+
If ran, ``make profile-opt`` will do several steps.
6161

6262
First, the entire Python directory is cleaned of temporary files that
6363
may have resulted in a previous compilation.
@@ -80,19 +80,17 @@ that is optimized and suitable for distribution or production installation.
8080
Link Time Optimization
8181
----------------------
8282

83-
Enabled via configure's --with-lto flag. LTO takes advantages of recent
84-
compiler toolchains ability to optimize across the otherwise arbitrary .o file
83+
Enabled via configure's ``--with-lto`` flag. LTO takes advantages of recent
84+
compiler toolchains ability to optimize across the otherwise arbitrary ``.o`` file
8585
boundary when building final executables or shared libraries for additional
8686
performance gains.
8787

8888

8989
What's New
9090
----------
9191

92-
We have a comprehensive overview of the changes in the "What's New in
93-
Python 3.7" document, found at
94-
95-
https://docs.python.org/3.7/whatsnew/3.7.html
92+
We have a comprehensive overview of the changes in the `What's New in
93+
Python 3.7 <https://docs.python.org/3.7/whatsnew/3.7.html>`_ document.
9694

9795
For a more detailed change log, read Misc/NEWS (though this file, too,
9896
is incomplete, and also doesn't list anything merged in from the 2.7
@@ -105,19 +103,17 @@ entitled "Installing multiple versions".
105103
Documentation
106104
-------------
107105

108-
Documentation for Python 3.7 is online, updated daily:
109-
110-
https://docs.python.org/3.7/
106+
`Documentation for Python 3.7 <https://docs.python.org/3.7/>`_ is online,
107+
updated daily.
111108

112109
It can also be downloaded in many formats for faster access. The documentation
113110
is downloadable in HTML, PDF, and reStructuredText formats; the latter version
114111
is primarily for documentation authors, translators, and people with special
115112
formatting requirements.
116113

117114
If you would like to contribute to the development of Python, relevant
118-
documentation is available at:
119-
120-
https://docs.python.org/devguide/
115+
documentation is available at: `Python Developer's Guide
116+
<https://docs.python.org/devguide/>`_.
121117

122118
For information about building Python's documentation, refer to Doc/README.txt.
123119

@@ -129,27 +125,28 @@ Python starting with 2.6 contains features to help locating code that needs to
129125
be changed, such as optional warnings when deprecated features are used, and
130126
backported versions of certain key Python 3.x features.
131127

132-
A source-to-source translation tool, "2to3", can take care of the mundane task
128+
A source-to-source translation tool, ``2to3``, can take care of the mundane task
133129
of converting large amounts of source code. It is not a complete solution but
134130
is complemented by the deprecation warnings in 2.6. See
135-
https://docs.python.org/3.7/library/2to3.html for more information.
131+
`2to3 documentation <https://docs.python.org/3.7/library/2to3.html>`_ for more
132+
information.
136133

137134

138135
Testing
139136
-------
140137

141-
To test the interpreter, type "make test" in the top-level directory.
138+
To test the interpreter, type ``make test`` in the top-level directory.
142139
The test set produces some output. You can generally ignore the messages
143140
about skipped tests due to optional features which can't be imported.
144141
If a message is printed about a failed test or a traceback or core dump
145142
is produced, something is wrong.
146143

147144
By default, tests are prevented from overusing resources like disk space and
148-
memory. To enable these tests, run "make testall".
145+
memory. To enable these tests, run ``make testall``.
149146

150147
IMPORTANT: If the tests fail and you decide to mail a bug report, *don't*
151-
include the output of "make test". It is useless. Run the failing test
152-
manually, as follows:
148+
include the output of ``make test``. It is useless. Run the failing test
149+
manually, as follows::
153150

154151
./python -m test -v test_whatever
155152

@@ -161,53 +158,49 @@ Installing multiple versions
161158
----------------------------
162159

163160
On Unix and Mac systems if you intend to install multiple versions of Python
164-
using the same installation prefix (--prefix argument to the configure script)
161+
using the same installation prefix (``--prefix`` argument to the configure script)
165162
you must take care that your primary python executable is not overwritten by the
166163
installation of a different version. All files and directories installed using
167-
"make altinstall" contain the major and minor version and can thus live
168-
side-by-side. "make install" also creates ${prefix}/bin/python3 which refers to
169-
${prefix}/bin/pythonX.Y. If you intend to install multiple versions using the
164+
``make altinstall`` contain the major and minor version and can thus live
165+
side-by-side. ``make install`` also creates ``${prefix}/bin/python3`` which refers to
166+
``${prefix}/bin/pythonX.Y``. If you intend to install multiple versions using the
170167
same prefix you must decide which version (if any) is your "primary" version.
171-
Install that version using "make install". Install all other versions using
172-
"make altinstall".
168+
Install that version using ``make install``. Install all other versions using
169+
``make altinstall``.
173170

174171
For example, if you want to install Python 2.7, 3.6, and 3.7 with 3.7 being the
175-
primary version, you would execute "make install" in your 3.7 build directory
176-
and "make altinstall" in the others.
172+
primary version, you would execute ``make install`` in your 3.7 build directory
173+
and ``make altinstall`` in the others.
177174

178175

179176
Issue Tracker and Mailing List
180177
------------------------------
181178

182179
We're soliciting bug reports about all aspects of the language. Fixes are also
183180
welcome, preferably in unified diff format. Please use the issue tracker:
184-
185-
https://bugs.python.org/
181+
`bugs.python.org <https://bugs.python.org/>`_.
186182

187183
If you're not sure whether you're dealing with a bug or a feature, use the
188-
mailing list:
189-
190-
191-
192-
To subscribe to the list, use the mailman form:
193-
194-
https://mail.python.org/mailman/listinfo/python-dev/
184+
mailing list: [email protected]. To subscribe to the list, use the mailman
185+
form: `python-dev <https://mail.python.org/mailman/listinfo/python-dev/>`_
195186

196187

197188
Proposals for enhancement
198189
-------------------------
199190

200191
If you have a proposal to change Python, you may want to send an email to the
201-
comp.lang.python or python-ideas mailing lists for initial feedback. A Python
192+
comp.lang.python or
193+
`python-ideas <https://mail.python.org/mailman/listinfo/python-ideas/>`_
194+
mailing lists for initial feedback. A Python
202195
Enhancement Proposal (PEP) may be submitted if your idea gains ground. All
203196
current PEPs, as well as guidelines for submitting a new PEP, are listed at
204-
https://www.python.org/dev/peps/.
197+
`python.org/dev/peps/ <https://www.python.org/dev/peps/>`_.
205198

206199

207200
Release Schedule
208201
----------------
209202

210-
See PEP 494 for release details: https://www.python.org/dev/peps/pep-0494/
203+
See :pep:`537` for Python 3.7 release details.
211204

212205

213206
Copyright and License Information

0 commit comments

Comments
 (0)