2. 安装

使用 pip 命令就可以安装 sphinx-console 库, 如 Bash 2.1 所示.

Bash 2.1 安装 sphinx-console
$ python3 -m pip install sphinx-console
Collecting sphinx-console
  Downloading sphinx_console-1.0.11-py3-none-any.whl (16 kB)
Requirement already satisfied: ansi2html==1.7.0 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from sphinx-console) (1.7.0)
Requirement already satisfied: beautifulsoup4==4.11.1 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from sphinx-console) (4.11.1)
Requirement already satisfied: colorama==0.4.4 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from sphinx-console) (0.4.4)
Collecting css-inline==0.8.6 (from sphinx-console)
  Downloading css_inline-0.8.6-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.4 MB)
[?25l                                              0.0/1.4 MB ? eta -:--:--
     ━━━━╸                                    0.2/1.4 MB 5.4 MB/s eta 0:00:01
     ━━━━━━━━━━━━╸                            0.5/1.4 MB 6.8 MB/s eta 0:00:01
     ━━━━━━━━━━━━━━━━━━━━━╸                   0.8/1.4 MB 7.7 MB/s eta 0:00:01
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━       1.2/1.4 MB 8.9 MB/s eta 0:00:01
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.4/1.4 MB 8.8 MB/s eta 0:00:00
[?25hRequirement already satisfied: docutils==0.17.1 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from sphinx-console) (0.17.1)
Requirement already satisfied: mezmorize==0.28.2 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from sphinx-console) (0.28.2)
Requirement already satisfied: pexpect==4.8.0 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from sphinx-console) (4.8.0)
Requirement already satisfied: Sphinx==4.4.0 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from sphinx-console) (4.4.0)
Requirement already satisfied: soupsieve>1.2 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from beautifulsoup4==4.11.1->sphinx-console) (2.5)
Requirement already satisfied: werkzeug<=2.0.0,>=0.15.0 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from mezmorize==0.28.2->sphinx-console) (2.0.0)
Requirement already satisfied: cachelib<=0.2,>=0.1 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from mezmorize==0.28.2->sphinx-console) (0.2.0)
Requirement already satisfied: ptyprocess>=0.5 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from pexpect==4.8.0->sphinx-console) (0.7.0)
Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (1.0.4)
Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (1.0.2)
Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (1.0.1)
Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (2.0.1)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (1.1.5)
Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (1.0.3)
Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (3.1.2)
Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (2.16.1)
Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (2.2.0)
Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (2.13.0)
Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (0.7.13)
Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (1.4.1)
Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (2.31.0)
Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (23.2)
Requirement already satisfied: importlib-metadata>=4.4 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Sphinx==4.4.0->sphinx-console) (6.8.0)
Requirement already satisfied: zipp>=0.5 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from importlib-metadata>=4.4->Sphinx==4.4.0->sphinx-console) (3.17.0)
Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from Jinja2>=2.3->Sphinx==4.4.0->sphinx-console) (2.1.3)
Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from requests>=2.5.0->Sphinx==4.4.0->sphinx-console) (3.3.0)
Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from requests>=2.5.0->Sphinx==4.4.0->sphinx-console) (3.4)
Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from requests>=2.5.0->Sphinx==4.4.0->sphinx-console) (2.0.6)
Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/sphinx-console/envs/latest/lib/python3.9/site-packages (from requests>=2.5.0->Sphinx==4.4.0->sphinx-console) (2023.7.22)
Installing collected packages: css-inline, sphinx-console
  Attempting uninstall: css-inline
    Found existing installation: css-inline 0.10.1
    Uninstalling css-inline-0.10.1:
      Successfully uninstalled css-inline-0.10.1
Successfully installed css-inline-0.8.6 sphinx-console-1.0.11

然后执行 python3 -m sphinxcontrib.console, 如果可以成功显示版本号, 则表示安装成功, 如 Bash 2.2 所示.

Bash 2.2 显示 sphinx-console 版本
$ python3 -m sphinxcontrib.console
hello sphinx-console
version is 1.0.12