Skip to content

Commit

Permalink
Some minor additional docs changes to master
Browse files Browse the repository at this point in the history
  • Loading branch information
earthgecko committed Aug 1, 2016
1 parent 5875841 commit e40abeb
Show file tree
Hide file tree
Showing 11 changed files with 55 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/_build/html/_sources/alert-testing.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ virtualenv and documentation PATHs as an example:
.. code-block:: bash

PYTHON_VIRTUALENV_DIR="/opt/python_virtualenv"
PROJECT="skyline2711"
PROJECT="skyline-py2712"

cd "${PYTHON_VIRTUALENV_DIR}/projects/${PROJECT}"
source bin/activate
Expand Down
10 changes: 10 additions & 0 deletions docs/_build/html/_sources/installation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,16 @@ Steps
the virtualenv pip, this can take a long time, the pandas install takes quite
a while.

.. warning:: When working with virtualenv Python versions you must always
remember to use the activate and deactivate commands to ensure you are using
the correct version of Python. Although running a virtualenv does not affect
the system Python, not using activate can result in the user making errors
that MAY affect the system Python and packages. For example, a user does not
use activate and just uses pip not bin/pip2.7 and pip installs some packages.
User error can result in the system Python being affected. Get in to the
habit of always using explicit bin/pip2.7 and bin/python2.7 commands to ensure
that it is harder for you to err.

.. code-block:: bash

PYTHON_MAJOR_VERSION="2.7"
Expand Down
11 changes: 7 additions & 4 deletions docs/_build/html/_sources/running-in-python-virtualenv.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,26 +51,29 @@ virtualenv. *NOTE:* if you are using a version of Python virtualenv
already, this may not suit your setup.

virtualenv must be >= 15.0.1 due to some recent changes in the pip and
setuptools, see *Recent changes in the pip environment* section in
setuptools, see **Recent changes in the pip environment** section in
`Requirements <requirements.html#recent-changes-in-the-pip-environment>`__
for more details.

This is using your system pip at this point only to install virtualenv.

.. code-block:: bash

pip install 'virtualenv>=15.0.1'

Python version
~~~~~~~~~~~~~~

Below we use the PATH /opt/python\_virtualenv, which you can substitute
with any path you choose and we are going to use python-2.7.12:
Below we use the path ``/opt/python_virtualenv``, which you can substitute
with any path you choose. We are going to use the Python-2.7.12 source and
build and install an isolated Python-2.7.12, this has no effect on your system
Python:

.. code-block:: bash

PYTHON_VERSION="2.7.12"
PYTHON_MAJOR_VERSION="2.7"
PYTHON_VIRTUALENV_DIR="/opt/python_virtualenv"
PR0JECT="skyline-py2712"

mkdir -p "${PYTHON_VIRTUALENV_DIR}/versions/${PYTHON_VERSION}"
mkdir -p "${PYTHON_VIRTUALENV_DIR}/projects"
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/alert-testing.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ <h1>Alert testing<a class="headerlink" href="#alert-testing" title="Permalink to
configured and working, do the following, once again using the Python-2.7.12
virtualenv and documentation PATHs as an example:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="nv">PYTHON_VIRTUALENV_DIR</span><span class="o">=</span><span class="s2">&quot;/opt/python_virtualenv&quot;</span>
<span class="nv">PROJECT</span><span class="o">=</span><span class="s2">&quot;skyline2711&quot;</span>
<span class="nv">PROJECT</span><span class="o">=</span><span class="s2">&quot;skyline-py2712&quot;</span>

<span class="nb">cd</span> <span class="s2">&quot;</span><span class="si">${</span><span class="nv">PYTHON_VIRTUALENV_DIR</span><span class="si">}</span><span class="s2">/projects/</span><span class="si">${</span><span class="nv">PROJECT</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="nb">source</span> bin/activate
Expand Down
12 changes: 12 additions & 0 deletions docs/_build/html/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,18 @@ <h2>Steps<a class="headerlink" href="#steps" title="Permalink to this headline">
the virtualenv pip, this can take a long time, the pandas install takes quite
a while.</li>
</ul>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">When working with virtualenv Python versions you must always
remember to use the activate and deactivate commands to ensure you are using
the correct version of Python. Although running a virtualenv does not affect
the system Python, not using activate can result in the user making errors
that MAY affect the system Python and packages. For example, a user does not
use activate and just uses pip not bin/pip2.7 and pip installs some packages.
User error can result in the system Python being affected. Get in to the
habit of always using explicit bin/pip2.7 and bin/python2.7 commands to ensure
that it is harder for you to err.</p>
</div>
<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="nv">PYTHON_MAJOR_VERSION</span><span class="o">=</span><span class="s2">&quot;2.7&quot;</span>
<span class="nv">PYTHON_VIRTUALENV_DIR</span><span class="o">=</span><span class="s2">&quot;/opt/python_virtualenv&quot;</span>
<span class="nv">PROJECT</span><span class="o">=</span><span class="s2">&quot;skyline-py2712&quot;</span>
Expand Down
Binary file modified docs/_build/html/mirage-1.pdf
Binary file not shown.
10 changes: 6 additions & 4 deletions docs/_build/html/running-in-python-virtualenv.html
Original file line number Diff line number Diff line change
Expand Up @@ -213,21 +213,23 @@ <h2>virtualenv<a class="headerlink" href="#virtualenv" title="Permalink to this
virtualenv. <em>NOTE:</em> if you are using a version of Python virtualenv
already, this may not suit your setup.</p>
<p>virtualenv must be &gt;= 15.0.1 due to some recent changes in the pip and
setuptools, see <em>Recent changes in the pip environment</em> section in
setuptools, see <strong>Recent changes in the pip environment</strong> section in
<a class="reference external" href="requirements.html#recent-changes-in-the-pip-environment">Requirements</a>
for more details.</p>
<p>This is using your system pip at this point only to install virtualenv.</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>pip install <span class="s1">&#39;virtualenv&gt;=15.0.1&#39;</span>
</pre></div>
</div>
</div>
<div class="section" id="python-version">
<h2>Python version<a class="headerlink" href="#python-version" title="Permalink to this headline"></a></h2>
<p>Below we use the PATH /opt/python_virtualenv, which you can substitute
with any path you choose and we are going to use python-2.7.12:</p>
<p>Below we use the path <code class="docutils literal"><span class="pre">/opt/python_virtualenv</span></code>, which you can substitute
with any path you choose. We are going to use the Python-2.7.12 source and
build and install an isolated Python-2.7.12, this has no effect on your system
Python:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="nv">PYTHON_VERSION</span><span class="o">=</span><span class="s2">&quot;2.7.12&quot;</span>
<span class="nv">PYTHON_MAJOR_VERSION</span><span class="o">=</span><span class="s2">&quot;2.7&quot;</span>
<span class="nv">PYTHON_VIRTUALENV_DIR</span><span class="o">=</span><span class="s2">&quot;/opt/python_virtualenv&quot;</span>
<span class="nv">PR0JECT</span><span class="o">=</span><span class="s2">&quot;skyline-py2712&quot;</span>

mkdir -p <span class="s2">&quot;</span><span class="si">${</span><span class="nv">PYTHON_VIRTUALENV_DIR</span><span class="si">}</span><span class="s2">/versions/</span><span class="si">${</span><span class="nv">PYTHON_VERSION</span><span class="si">}</span><span class="s2">&quot;</span>
mkdir -p <span class="s2">&quot;</span><span class="si">${</span><span class="nv">PYTHON_VIRTUALENV_DIR</span><span class="si">}</span><span class="s2">/projects&quot;</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Large diffs are not rendered by default.

Binary file modified docs/_build/plot_directive/mirage-1.pdf
Binary file not shown.
10 changes: 10 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,16 @@ Steps
the virtualenv pip, this can take a long time, the pandas install takes quite
a while.

.. warning:: When working with virtualenv Python versions you must always
remember to use the activate and deactivate commands to ensure you are using
the correct version of Python. Although running a virtualenv does not affect
the system Python, not using activate can result in the user making errors
that MAY affect the system Python and packages. For example, a user does not
use activate and just uses pip not bin/pip2.7 and pip installs some packages.
User error can result in the system Python being affected. Get in to the
habit of always using explicit bin/pip2.7 and bin/python2.7 commands to ensure
that it is harder for you to err.

.. code-block:: bash
PYTHON_MAJOR_VERSION="2.7"
Expand Down
11 changes: 7 additions & 4 deletions docs/running-in-python-virtualenv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,26 +51,29 @@ virtualenv. *NOTE:* if you are using a version of Python virtualenv
already, this may not suit your setup.

virtualenv must be >= 15.0.1 due to some recent changes in the pip and
setuptools, see *Recent changes in the pip environment* section in
setuptools, see **Recent changes in the pip environment** section in
`Requirements <requirements.html#recent-changes-in-the-pip-environment>`__
for more details.

This is using your system pip at this point only to install virtualenv.

.. code-block:: bash
pip install 'virtualenv>=15.0.1'
Python version
~~~~~~~~~~~~~~

Below we use the PATH /opt/python\_virtualenv, which you can substitute
with any path you choose and we are going to use python-2.7.12:
Below we use the path ``/opt/python_virtualenv``, which you can substitute
with any path you choose. We are going to use the Python-2.7.12 source and
build and install an isolated Python-2.7.12, this has no effect on your system
Python:

.. code-block:: bash
PYTHON_VERSION="2.7.12"
PYTHON_MAJOR_VERSION="2.7"
PYTHON_VIRTUALENV_DIR="/opt/python_virtualenv"
PR0JECT="skyline-py2712"
mkdir -p "${PYTHON_VIRTUALENV_DIR}/versions/${PYTHON_VERSION}"
mkdir -p "${PYTHON_VIRTUALENV_DIR}/projects"
Expand Down

0 comments on commit e40abeb

Please sign in to comment.