diff options
| author | Srinivas Nyayapati <shireenrao@gmail.com> | 2020-07-19 23:56:47 -0400 |
|---|---|---|
| committer | Srinivas Nyayapati <shireenrao@gmail.com> | 2020-09-13 20:47:16 -0400 |
| commit | 119d8666b4b3e59c531afcf970cd0ae2d0f3cdf0 (patch) | |
| tree | bfba504599077d4961875fe6ea8812b78a57de04 | |
| parent | 2329d796897867cacf6b7b35b44ca16f89ae79bb (diff) | |
| download | pip-119d8666b4b3e59c531afcf970cd0ae2d0f3cdf0.tar.gz | |
implement sphinx-tabs on installing page of docs
| -rw-r--r-- | docs/html/conf.py | 2 | ||||
| -rw-r--r-- | docs/html/installing.rst | 10 | ||||
| -rw-r--r-- | tools/requirements/docs.txt | 1 |
3 files changed, 10 insertions, 3 deletions
diff --git a/docs/html/conf.py b/docs/html/conf.py index 2ef2647ce..c5c2e02e6 100644 --- a/docs/html/conf.py +++ b/docs/html/conf.py @@ -30,7 +30,7 @@ sys.path.insert(0, docs_dir) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions = ['sphinx.ext.autodoc'] -extensions = ['sphinx.ext.extlinks', 'pip_sphinxext', 'sphinx.ext.intersphinx'] +extensions = ['sphinx.ext.extlinks', 'pip_sphinxext', 'sphinx.ext.intersphinx', 'sphinx_tabs.tabs'] # intersphinx intersphinx_cache_limit = 0 diff --git a/docs/html/installing.rst b/docs/html/installing.rst index 4c2c2eca3..9653331a4 100644 --- a/docs/html/installing.rst +++ b/docs/html/installing.rst @@ -97,9 +97,15 @@ the `Python Packaging User Guide Upgrading pip ============= -In a shell:: +.. tabs:: - python -m pip install -U pip + .. tab:: Linux/MacOS + + python -m pip install -U pip + + .. tab:: Windows + + py -m pip install -U pip .. _compatibility-requirements: diff --git a/tools/requirements/docs.txt b/tools/requirements/docs.txt index 267d5b1dd..10a9b0c60 100644 --- a/tools/requirements/docs.txt +++ b/tools/requirements/docs.txt @@ -1,6 +1,7 @@ sphinx == 3.2.1 git+https://github.com/python/python-docs-theme.git#egg=python-docs-theme git+https://github.com/pypa/pypa-docs-theme.git#egg=pypa-docs-theme +https://github.com/djungelorm/sphinx-tabs/releases/download/v1.1.13/sphinx-tabs-1.1.13.tar.gz # `docs.pipext` uses pip's internals to generate documentation. So, we install # the current directory to make it work. |