From 2cf5784d44d493902f6457c864197dfd33141823 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 18 Aug 2018 12:23:03 -0700 Subject: Clean up code-blocks in qt/requirements --- docs/quick_tutorial/requirements.rst | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) (limited to 'docs/quick_tutorial/requirements.rst') diff --git a/docs/quick_tutorial/requirements.rst b/docs/quick_tutorial/requirements.rst index 29f263176..0da56ca0b 100644 --- a/docs/quick_tutorial/requirements.rst +++ b/docs/quick_tutorial/requirements.rst @@ -94,18 +94,18 @@ For Linux, the commands to do so are as follows: .. code-block:: bash # Mac and Linux - $ cd ~ - $ mkdir -p projects/quick_tutorial - $ cd projects/quick_tutorial + cd ~ + mkdir -p projects/quick_tutorial + cd projects/quick_tutorial For Windows: .. code-block:: doscon # Windows - c:\> cd \ - c:\> mkdir projects\quick_tutorial - c:\> cd projects\quick_tutorial + cd \ + mkdir projects\quick_tutorial + cd projects\quick_tutorial In the above figure, your user home directory is represented by ``~``. In your home directory, all of your projects are in the ``projects`` directory. This is @@ -130,12 +130,12 @@ environment`. We set an environment variable to save typing later. .. code-block:: bash # Mac and Linux - $ export VENV=~/projects/quick_tutorial/env + export VENV=~/projects/quick_tutorial/env .. code-block:: doscon # Windows - c:\> set VENV=c:\projects\quick_tutorial\env + set VENV=c:\projects\quick_tutorial\env .. _create-a-virtual-environment: @@ -151,12 +151,12 @@ environment variable. .. code-block:: bash # Mac and Linux - $ python3 -m venv $VENV + python3 -m venv $VENV .. code-block:: doscon # Windows - c:\> python -m venv %VENV% + python -m venv %VENV% .. seealso:: See also Python 3's :mod:`venv module ` and Python 2's `virtualenv `_ package. @@ -172,12 +172,12 @@ time of its release. .. code-block:: bash # Mac and Linux - $ $VENV/bin/pip install --upgrade pip setuptools + $VENV/bin/pip install --upgrade pip setuptools .. code-block:: doscon # Windows - c:\> %VENV%\Scripts\pip install --upgrade pip setuptools + %VENV%\Scripts\pip install --upgrade pip setuptools .. seealso:: See also :ref:`Why use $VENV/bin/pip instead of source bin/activate, then pip `. @@ -194,10 +194,10 @@ part is pretty easy. We'll also install a WSGI server, Waitress. .. parsed-literal:: # Mac and Linux - $ $VENV/bin/pip install "pyramid==\ |release|\ " waitress + $VENV/bin/pip install "pyramid==\ |release|\ " waitress # Windows - c:\\> %VENV%\\Scripts\\pip install "pyramid==\ |release|\ " waitress + %VENV%\\Scripts\\pip install "pyramid==\ |release|\ " waitress Our Python virtual environment now has the Pyramid software available as well as the ``waitress`` package. -- cgit v1.2.3 From 5af30057aa5528eaa277603ee717b7111c147a51 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 19 Aug 2018 00:36:46 -0700 Subject: Standardize Unix capitalization --- docs/quick_tutorial/requirements.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'docs/quick_tutorial/requirements.rst') diff --git a/docs/quick_tutorial/requirements.rst b/docs/quick_tutorial/requirements.rst index 0da56ca0b..746af8207 100644 --- a/docs/quick_tutorial/requirements.rst +++ b/docs/quick_tutorial/requirements.rst @@ -33,7 +33,7 @@ This *Quick Tutorial* is based on: projects* (a directory with packaging information and *Python packages* of working code.) -* **Unix commands**. Commands in this tutorial use UNIX syntax and paths. +* **Unix commands**. Commands in this tutorial use Unix syntax and paths. Windows users should adjust commands accordingly. .. note:: @@ -89,11 +89,11 @@ will reside as we proceed through the tutorial: │ └── app.py └── setup.py -For Linux, the commands to do so are as follows: +For macOS and Linux, the commands to do so are as follows: .. code-block:: bash - # Mac and Linux + # macOS and Linux cd ~ mkdir -p projects/quick_tutorial cd projects/quick_tutorial @@ -129,7 +129,7 @@ environment`. We set an environment variable to save typing later. .. code-block:: bash - # Mac and Linux + # macOS and Linux export VENV=~/projects/quick_tutorial/env .. code-block:: doscon @@ -150,7 +150,7 @@ environment variable. .. code-block:: bash - # Mac and Linux + # macOS and Linux python3 -m venv $VENV .. code-block:: doscon @@ -171,7 +171,7 @@ time of its release. .. code-block:: bash - # Mac and Linux + # macOS and Linux $VENV/bin/pip install --upgrade pip setuptools .. code-block:: doscon @@ -193,7 +193,7 @@ part is pretty easy. We'll also install a WSGI server, Waitress. .. parsed-literal:: - # Mac and Linux + # macOS and Linux $VENV/bin/pip install "pyramid==\ |release|\ " waitress # Windows -- cgit v1.2.3 From 254710cb716dccfe536b20d077e3cb79be19c6b3 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 19 Aug 2018 00:40:12 -0700 Subject: Standardize macOS capitalization --- docs/quick_tutorial/requirements.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/quick_tutorial/requirements.rst') diff --git a/docs/quick_tutorial/requirements.rst b/docs/quick_tutorial/requirements.rst index 746af8207..08ea93cb2 100644 --- a/docs/quick_tutorial/requirements.rst +++ b/docs/quick_tutorial/requirements.rst @@ -62,7 +62,7 @@ Install Python 3 See the detailed recommendation for your operating system described under :ref:`installing_chapter`. -- :ref:`for-mac-os-x-users` +- :ref:`for-macos-users` - :ref:`if-you-don-t-yet-have-a-python-interpreter-unix` - :ref:`if-you-don-t-yet-have-a-python-interpreter-windows` -- cgit v1.2.3