問題タブ [pydoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
2 に答える
1291 参照

python - Python: pydoc モジュールは HTML ドキュメントを相対パスで出力できますか?

C API で定義したいくつかの型のドキュメントを出力するために pydoc モジュールを使用しています。文書化したい型は、インタープリターが C プログラムに組み込まれるまで存在しないため、pydoc コマンドを使用できません。

次のような関数を呼び出す C コードを取得します。

これは機能しますが、ハードコードされた「file:/」リンク ターゲットを含む HTML ページが生成されます。リンクに相対パスを使用する方法はありますか?

(C API で定義された型を文書化するためのより良い方法のための追加ポイント)

0 投票する
2 に答える
1382 参照

python - PyDoc を Jira Confluence に取り込む方法

PyDoc を使用して Python コードからドキュメントを生成し、Jira の Confluence プラグインを使用してドキュメントを管理しています。PyDoc ドキュメントを生成して Confluence に入れる方法はありますか?

グーグルはあまり多くの結果をもたらしませんでした。

みんな、ありがとう

0 投票する
3 に答える
1167 参照

python - pydoc と help() の違いは?

この二つは違うものですか?この 2 つが Python で与える結果は似ています。

0 投票する
1 に答える
4536 参照

python - Eclipse/Pydevを使用してPythonを文書化する

私はPython開発に不慣れで、Eclipse/Pydevを使用しています。ドキュメントを生成するためのツール(Sphinx、pydocなど)をIDEに統合して、ドキュメントを別のタブに表示するなど、優れたワークフローを実現するための優れた方法はありますか?

0 投票する
4 に答える
30664 参照

python - help() の出力を印刷するオプションはありますか?

help('myfun') の出力を印刷するオプションはありますか。私が見ている動作は、出力が std.out に出力され、スクリプトがユーザー入力を待機することです (つまり、「q」と入力して続行します)。

docstring だけをダンプするように設定する必要があります。

あるいは、docstring と "def f(args):" 行をダンプするだけでも問題ありません。

「python ヘルプ機能」で検索するとコミカルです。:) たぶん、それをすべて説明している素敵なpydocページがどこかにありませんか?

0 投票する
2 に答える
11907 参照

python - ユーザー定義ディレクトリにドキュメントを生成するよう PyDoc に指示する方法

PyDoc は、モジュールのドキュメントを生成するときに、現在のディレクトリに HTML ドキュメントを作成します。PyDoc が呼び出されるディレクトリではなく、生成されたドキュメントのプレースホルダーとなる別のディレクトリを指定する必要があります。

python -m pydoc -w <MODULES_DIR>ドキュメントの生成に使用しています。

これは可能ですか?

0 投票する
1 に答える
330 参照

python - pydoc は、ファイル ハンドル パラメーターを使用してヘルプ テキストを生成しました

次のパラメーター リストを持つ関数があります。

残念ながら、モジュールの pydoc ヘルプ テキストには次のように表示されます。

file=sys.stdoutオブジェクトの詳細を表示するのではなく、ファイル引数をpydocに与えるにはどうすればよいですか?

ちなみにPython3.2です。

0 投票する
1 に答える
215 参照

java - コマンド ラインからドキュメントを読み取るための Java 用の pydoc analog を探します。

Pydoc は、コマンド ラインから読み取るための Python モジュール/関数/クラスの優れたドキュメントを生成できます。

このツールjavadocは、そのような機能を提供していないようです。

私は Emacs を使用しており、Emacs を離れずに標準の Java ライブラリに関するドキュメントをすばやく取得できる機能を探しています。

そのようなユーティリティがあれば、Emacs に統合できます...

また、Bashからjavadocを読むのもいいと思います...

PS。たとえば、ユーティリティがパスを指定せずに既存の Java インストールからドキュメントを抽出することを期待しています ( JAVA_HOMEから、またはすべてのJDKインストールに付属する src.zip からのみ javadoc.zip なしのPATHから)...

0 投票する
1 に答える
203 参照

c# - pydocに相当するC#

Visual Studioが私の職場に存在せず、開発にNotepad++を使用しています。私はMSDNを知っていますが、Pythonのようにコマンドラインからドキュメントを閲覧したいと思います。

Pythonでは、モジュールや関数などのドキュメントを参照できます。

与える

次のことができるC#に似たものがあるかどうかを調べたいと思います。

そして、Console.ReadLineメソッドに関するヘルプが表示されます。

これを行う方法はありますか?