shpinxでapiのドキュメント生成をする時の注意点 - プログラミングの話
sphinxとは？ ドキュメントを作るのがめんどくさい時に利用できるツールでして。 くわしくはこっちを見てください。 この記事の目的 このsphinxってやつは結構賢くて、有るパッケージ以下を認識させると、それ以下のpythonのパッケージを読み取ってくれて、 ファイルに記述されているコメントからドキュメント生成してくれます。 今回はそのコマンドを利用する際の注意点を幾つか挙げられれば。 コマンドの利用方法 インストール 1 pip install sphinx 利用方法 1 2 3 #sphinx-apidoc -f -o 出力先ディレクトリ調査対象ディレクトリ #例) app内を調査し、docsに出力する sphinx-apidoc -f -o docs/ app/ 注意点 config.pyを書き換える rst記法を学ぶ __init__.pyが大事 ライブラリから関数をインポートし
Sphinx で自動的にAPIリファレンスを作成したい - Study08.net 対シンバシ殲滅用人型機動兵器
今日はこのネタです。タイトルの通りなんですが、PythonでそもそもAPIリファレンス的なドキュメントをどうやって作ったら良いのか知りませんでした。 他の言語であれば下記のようなツールを過去に使った事がありました。 Java なら Javadoc Perl なら pod2html PHP なら PHPDocumentor (今ならもっと賢いツールありそうだけど。。。) Pythonなら? ではPythonであればどのような選択肢があるでしょう。調べた限りではまず下記のような選択肢がありました。 pydoc -w でHTML生成 (pydocで簡単なPythonファイルのドキュメントを作成する) Epydocを利用する (Epydoc - 偏った言語信者の垂れ流し) javadocやらphpdocmentorやらのように、まるっとソースからHTMLを生成するだけであれば、これで十分かもしれま
メモ (プログラムなどに関する雑記) [Python][Sphinx] PythonのAPIドキュメンテーションに関して
門外漢故に色々調べて設定していただけで時間がなくなる羽目になった。ツールに踊らされているのだ……。 先に述べておくが、利用しているのはPython2.7である。一応SphinxでAPIドキュメントを書くにあたって躓いたりしたところを書いているのでそれ目当ての人には役に立つかも？ Pythonはjavadocのようなドキュメンテーションを行うことができないとか言われる。で、調べたところpydocが使えるだとかepydocだとか言われるのだが、Windows上ではpydocを用いてhtmlを作成しても文字化けが災いし上手く日本語に出来なかった。コマンドプロンプトがデフォルトでShift-JISだからかと思いUTF-8にするも失敗し、断念。一応pydocの利用方法を書いておく。 pydoc in Windows まずpipはインストールされているとする。以下のコマンドでpydocを取得。 > p
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
https://sphinx-users.jp/gettingstarted/