Pythonプログラムのドキュメントを自動生成する「pdoc」をインストールする

Pythonプログラムのドキュメントを自動生成する「pdoc」のインストールについて解説しています。

pdocのライブラリは、Pythonプログラムのドキュメントを自動生成することができるツールです。ドキュメントはプレーンなMarkdownで生成されます。

Python3.7以降と互換性があります。

■Python

今回のPythonのバージョンは、「3.8.5」を使用しています。(Windows10)(pythonランチャーでの確認)

■pdocをインストールする

pdocをインストールを行いますが、今回はpipを経由してインストールを行うので、まずWindowsのコマンドプロンプトを起動します。

pip install pdoc

起動後、上記のコマンドを入力し、Enterキーを押します。

なお、今回は、pythonランチャーを使用しており、Python Version 3.8.5にインストールを行うために、pipを使う場合にはコマンドでの切り替えを行います。

py -3.8 -m pip install pdoc

切り替えるために、上記のコマンドを入力し、Enterキーを押します。

Defaulting to user installation because normal site-packages is not writeable
Collecting pdoc
Downloading pdoc-7.4.0-py3-none-any.whl (106 kB)
|████████████████████████████████| 106 kB 930 kB/s
Requirement already satisfied: MarkupSafe in c:\users\user_\appdata\roaming\python\python38\site-packages (from pdoc) (2.0.1)
Requirement already satisfied: astunparse; python_version < “3.9” in c:\users\user_\appdata\roaming\python\python38\site-packages (from pdoc) (1.6.3)
Requirement already satisfied: pygments in c:\users\user_\appdata\roaming\python\python38\site-packages (from pdoc) (2.9.0)
Requirement already satisfied: Jinja2>=2.11.0 in c:\users\user_\appdata\roaming\python\python38\site-packages (from pdoc) (3.0.1)
Requirement already satisfied: wheel<1.0,>=0.23.0 in c:\users\user_\appdata\roaming\python\python38\site-packages (from astunparse; python_version < “3.9”->pdoc) (0.36.2)
Requirement already satisfied: six<2.0,>=1.6.1 in c:\users\user_\appdata\roaming\python\python38\site-packages (from astunparse; python_version < “3.9”->pdoc) (1.15.0)
Installing collected packages: pdoc
Successfully installed pdoc-7.4.0

Enterキーを押すと、インストールが開始され、上記のように「Successfully installed」と表示されます。これが表示されれば、pdocが正常にインストールされたことになります。

なお、今回はpdocのバージョン7.4.0をインストールしました。

コメント

タイトルとURLをコピーしました