Pydocでドキュメントを作成するにはどうすればよいですか?
2023-08-05 10:56:04
質問
私のモジュールからドキュメントを作成しようとしています。私は使用した
pydoc
を Windows 7 で Python 3.2.3 を使ってコマンドラインから実行しました。
python "<path_to_pydoc_>\pydoc.py" -w myModule
この結果、私のシェルは、私のモジュール内の各ファイルに対して1行ずつ、次のようなテキストで埋め尽くされることになりました。
no Python documentation found for '<file_name>'
まるでPydocが私のファイルのドキュメントを取得しようとしているようですが、私はそれを自動作成したいのです。Googleを使っても良いチュートリアルが見つかりませんでした。どなたかPydocの使い方のヒントをお持ちの方はいらっしゃいませんか?
を使って1つのファイルからドキュメントを作成しようとすると
python ... -w myModule\myFile.py
とあるように
wrote myFile.html
と書いてあり、開くと1行でこう書いてあります。
# ../myModule/myFile.py
また、私のコンピューター上のファイルそのものへのリンクがあり、これをクリックすると、ウェブブラウザーでファイルの中身を表示することができます。
どのように解決するのですか?
RocketDonkeyが提案したように、モジュール自体にいくつかのdocstringを持たせる必要があります。
例えば
myModule/__init__.py
:
"""
The mod module
"""
また、各ファイルのドキュメントを
myModule/*.py
を使って
pydoc myModule.thefilename
で、生成されたファイルがメインモジュールのドキュメントファイルから参照されるものと一致することを確認します。
関連
-
[解決済み] プログラムの実行やシステムコマンドの呼び出しはどのように行うのですか?
-
[解決済み] リストのリストからフラットなリストを作るには?
-
[解決済み] リストが空かどうかを確認するにはどうすればよいですか?
-
[解決済み] pipでPythonの全パッケージをアップグレードする方法
-
[解決済み] Pythonで複数行のコメントを作成する方法はありますか?
-
[解決済み】ネストされたディレクトリを安全に作成するには?
-
[解決済み】2つの辞書を1つの式でマージする(辞書の和をとる)には?)
-
[解決済み] Pandasのデータフレームでタプルの列を分割するにはどうしたらいいですか?
-
[解決済み] Pythonのインスタンス変数とクラス変数
-
[解決済み] PySparkでデータフレームのカラムをString型からDouble型に変更する方法は?
最新
-
nginxです。[emerg] 0.0.0.0:80 への bind() に失敗しました (98: アドレスは既に使用中です)
-
htmlページでギリシャ文字を使うには
-
ピュアhtml+cssでの要素読み込み効果
-
純粋なhtml + cssで五輪を実現するサンプルコード
-
ナビゲーションバー・ドロップダウンメニューのHTML+CSSサンプルコード
-
タイピング効果を実現するピュアhtml+css
-
htmlの選択ボックスのプレースホルダー作成に関する質問
-
html css3 伸縮しない 画像表示効果
-
トップナビゲーションバーメニュー作成用HTML+CSS
-
html+css 実装 サイバーパンク風ボタン
おすすめ
-
[解決済み] 2つの線分が交差しているかどうかを確認するにはどうすればよいですか?
-
[解決済み] Jupyterノートブックでenv変数を設定する方法
-
[解決済み] PythonでSVGからPNGに変換する
-
[解決済み] Django のテストデータベースをメモリ上だけで動作させるには?
-
[解決済み] DataFrameに日付間の日数カラムを追加する pandas
-
[解決済み] Django Rest Framework ファイルアップロード
-
[解決済み] djangoフレームワークでフォームフィールドから値を取得するには?
-
[解決済み] Pythonによる一対のクロスプロダクト [重複] (英語)
-
[解決済み] Pythonの文字列書式をリストで使う
-
[解決済み] virtualenvsはどこに作成するのですか?