Skip to content

Switch to sphinx-inline-tabs for tabs #9008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 19, 2020
Merged

Switch to sphinx-inline-tabs for tabs #9008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/html/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',
# third-party:
'sphinx_tabs.tabs',
'sphinx_inline_tabs',
# in-tree:
'docs_feedback_sphinxext',
'pip_sphinxext',
Expand Down
26 changes: 12 additions & 14 deletions docs/html/development/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,25 +38,23 @@ To run the pip executable from your source tree during development, install pip
locally using editable installation (inside a virtualenv).
You can then invoke your local source tree pip normally.

.. tabs::
.. tab:: Unix/macOS

.. group-tab:: Unix/macOS
.. code-block:: shell

.. code-block:: shell
virtualenv venv # You can also use "python -m venv venv" from python3.3+
source venv/bin/activate
python -m pip install -e .
python -m pip --version

virtualenv venv # You can also use "python -m venv venv" from python3.3+
source venv/bin/activate
python -m pip install -e .
python -m pip --version
.. tab:: Windows

.. group-tab:: Windows
.. code-block:: shell

.. code-block:: shell

virtualenv venv # You can also use "py -m venv venv" from python3.3+
venv\Scripts\activate
py -m pip install -e .
py -m pip --version
virtualenv venv # You can also use "py -m venv venv" from python3.3+
venv\Scripts\activate
py -m pip install -e .
py -m pip --version

Running Tests
=============
Expand Down
84 changes: 36 additions & 48 deletions docs/html/installing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,17 @@ this link: `get-pip.py
Then run the following command in the folder where you
have downloaded ``get-pip.py``:

.. tabs::
.. tab:: Unix/macOS

.. group-tab:: Unix/macOS
.. code-block:: shell

.. code-block:: shell
python get-pip.py

python get-pip.py
.. tab:: Windows

.. group-tab:: Windows
.. code-block:: shell

.. code-block:: shell

py get-pip.py
py get-pip.py


.. warning::
Expand Down Expand Up @@ -81,68 +79,60 @@ some examples:

Install from local copies of pip and setuptools:

.. tabs::

.. group-tab:: Unix/macOS
.. tab:: Unix/macOS

.. code-block:: shell
.. code-block:: shell

python get-pip.py --no-index --find-links=/local/copies
python get-pip.py --no-index --find-links=/local/copies

.. group-tab:: Windows
.. tab:: Windows

.. code-block:: shell
.. code-block:: shell

py get-pip.py --no-index --find-links=/local/copies
py get-pip.py --no-index --find-links=/local/copies

Install to the user site [3]_:

.. tabs::

.. group-tab:: Unix/macOS
.. tab:: Unix/macOS

.. code-block:: shell
.. code-block:: shell

python get-pip.py --user
python get-pip.py --user

.. group-tab:: Windows
.. tab:: Windows

.. code-block:: shell
.. code-block:: shell

py get-pip.py --user
py get-pip.py --user

Install behind a proxy:

.. tabs::
.. tab:: Unix/macOS

.. group-tab:: Unix/macOS
.. code-block:: shell

.. code-block:: shell
python get-pip.py --proxy="http://[user:passwd@]proxy.server:port"

python get-pip.py --proxy="http://[user:passwd@]proxy.server:port"
.. tab:: Windows

.. group-tab:: Windows
.. code-block:: shell

.. code-block:: shell

py get-pip.py --proxy="http://[user:passwd@]proxy.server:port"
py get-pip.py --proxy="http://[user:passwd@]proxy.server:port"

``get-pip.py`` can also be used to install a specified combination of ``pip``,
``setuptools``, and ``wheel`` using the same requirements syntax as pip:

.. tabs::

.. group-tab:: Unix/macOS
.. tab:: Unix/macOS

.. code-block:: shell
.. code-block:: shell

python get-pip.py pip==9.0.2 wheel==0.30.0 setuptools==28.8.0
python get-pip.py pip==9.0.2 wheel==0.30.0 setuptools==28.8.0

.. group-tab:: Windows
.. tab:: Windows

.. code-block:: shell
.. code-block:: shell

py get-pip.py pip==9.0.2 wheel==0.30.0 setuptools==28.8.0
py get-pip.py pip==9.0.2 wheel==0.30.0 setuptools==28.8.0

Using Linux Package Managers
============================
Expand All @@ -156,19 +146,17 @@ the `Python Packaging User Guide
Upgrading pip
=============

.. tabs::

.. group-tab:: Unix/macOS
.. tab:: Unix/macOS

.. code-block:: shell
.. code-block:: shell

python -m pip install -U pip
python -m pip install -U pip

.. group-tab:: Windows
.. tab:: Windows

.. code-block:: shell
.. code-block:: shell

py -m pip install -U pip
py -m pip install -U pip


.. _compatibility-requirements:
Expand Down
Loading