summaryrefslogtreecommitdiff
path: root/docs/narr/install.rst
diff options
context:
space:
mode:
authorMichael Merickel <github@m.merickel.org>2018-08-21 01:44:55 -0500
committerGitHub <noreply@github.com>2018-08-21 01:44:55 -0500
commit820a752645b460ea8009b07a75c752ab09c53dec (patch)
tree14616d81a7abedfe523c057e71ed7b2aca680754 /docs/narr/install.rst
parentdf8598a2658632f709a64e8076cce02ca49de8e6 (diff)
parent254710cb716dccfe536b20d077e3cb79be19c6b3 (diff)
downloadpyramid-820a752645b460ea8009b07a75c752ab09c53dec.tar.gz
pyramid-820a752645b460ea8009b07a75c752ab09c53dec.tar.bz2
pyramid-820a752645b460ea8009b07a75c752ab09c53dec.zip
Merge pull request #3330 from stevepiercy/docs-code-style
Docs code style
Diffstat (limited to 'docs/narr/install.rst')
-rw-r--r--docs/narr/install.rst50
1 files changed, 25 insertions, 25 deletions
diff --git a/docs/narr/install.rst b/docs/narr/install.rst
index a9ec68d61..80d5ea3de 100644
--- a/docs/narr/install.rst
+++ b/docs/narr/install.rst
@@ -24,8 +24,8 @@ the following sections.
As of this writing, :app:`Pyramid` is tested against Python 2.7,
Python 3.4, Python 3.5, Python 3.6, and PyPy.
-:app:`Pyramid` is known to run on all popular UNIX-like systems such as Linux,
-Mac OS X, and FreeBSD, as well as on Windows platforms. It is also known to
+:app:`Pyramid` is known to run on all popular Unix-like systems such as Linux,
+macOS, and FreeBSD, as well as on Windows platforms. It is also known to
run on :term:`PyPy` (1.9+).
:app:`Pyramid` installation does not require the compilation of any C code.
@@ -42,24 +42,24 @@ instead.
compiler and the Python header files installed for your operating system.
-.. _for-mac-os-x-users:
+.. _for-macos-users:
-For Mac OS X Users
-~~~~~~~~~~~~~~~~~~
+For macOS Users
+~~~~~~~~~~~~~~~
-Python comes pre-installed on Mac OS X, but due to Apple's release cycle, it is
+Python comes pre-installed on macOS, but due to Apple's release cycle, it is
often out of date. Unless you have a need for a specific earlier version, it is
recommended to install the latest 3.x version of Python.
-You can install the latest version of Python for Mac OS X from the binaries on
+You can install the latest version of Python for macOS from the binaries on
`python.org <https://www.python.org/downloads/mac-osx/>`_.
Alternatively, you can use the `homebrew <https://brew.sh/>`_ package manager.
-.. code-block:: text
+.. code-block:: bash
- # for python 3.x
- $ brew install python3
+ # for python 3.x
+ brew install python3
If you use an installer for your Python, then you can skip to the section
:ref:`installing_unix`.
@@ -67,12 +67,12 @@ If you use an installer for your Python, then you can skip to the section
.. _if-you-don-t-yet-have-a-python-interpreter-unix:
-If You Don't Yet Have a Python Interpreter (UNIX)
+If You Don't Yet Have a Python Interpreter (Unix)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If your system doesn't have a Python interpreter, and you're on UNIX, you can
+If your system doesn't have a Python interpreter, and you're on Unix, you can
either install Python using your operating system's package manager *or* you
-can install Python from source fairly easily on any UNIX system that has
+can install Python from source fairly easily on any Unix system that has
development tools.
.. seealso:: See the official Python documentation :ref:`Using Python on Unix
@@ -162,15 +162,15 @@ application, rather than being installed system wide.
.. index::
- single: installing on UNIX
- single: installing on Mac OS X
+ single: installing on Unix
+ single: installing on macOS
.. _installing_unix:
-Installing :app:`Pyramid` on a UNIX System
+Installing :app:`Pyramid` on a Unix System
------------------------------------------
-After installing Python as described previously in :ref:`for-mac-os-x-users` or
+After installing Python as described previously in :ref:`for-macos-users` or
:ref:`if-you-don-t-yet-have-a-python-interpreter-unix`, and satisfying the
:ref:`requirements-for-installing-packages`, you can now install Pyramid.
@@ -178,8 +178,8 @@ After installing Python as described previously in :ref:`for-mac-os-x-users` or
.. code-block:: bash
- $ export VENV=~/env
- $ python3 -m venv $VENV
+ export VENV=~/env
+ python3 -m venv $VENV
You can either follow the use of the environment variable ``$VENV``, or
replace it with the root directory of the virtual environment. If you choose
@@ -193,7 +193,7 @@ After installing Python as described previously in :ref:`for-mac-os-x-users` or
.. parsed-literal::
- $ $VENV/bin/pip install "pyramid==\ |release|\ "
+ $VENV/bin/pip install "pyramid==\ |release|\ "
.. index::
single: $VENV/bin/pip vs. source bin/activate
@@ -233,10 +233,10 @@ After installing Python as described previously in
.. code-block:: doscon
- c:\> cd \
- c:\> set VENV=c:\env
- c:\> python -m venv %VENV%
- c:\> cd %VENV%
+ cd \
+ set VENV=c:\env
+ python -m venv %VENV%
+ cd %VENV%
You can either follow the use of the environment variable ``%VENV%``, or
replace it with the root directory of the virtual environment. If you choose
@@ -250,7 +250,7 @@ After installing Python as described previously in
.. parsed-literal::
- c:\\> %VENV%\\Scripts\\pip install "pyramid==\ |release|\ "
+ %VENV%\\Scripts\\pip install "pyramid==\ |release|\ "
.. note:: See the note above for :ref:`Why use $VENV/bin/pip instead of source
bin/activate, then pip <venv-bin-pip-vs-source-bin-activate>`.