問題タブ [python-sphinx]
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.
python - Sphinx を使用して個人の Web サイトやブログを作成する
Sphinxは、一連のReST形式のテキスト ファイルから適切なドキュメントを生成する Python ライブラリです。
Sphinx プラグインを作成して個人の Web サイトやブログを作成した人がいるのだろうか。
特にブログの場合、投稿を時系列で自動的に一覧表示し、RSS フィードを生成する方法が必要です。このような特別なページ/xml 生成を行うには、Sphinx プラグインを作成する必要があります。
誰もこれを試したことがありますか?
python - Sphinx (ドキュメンテーション ツール): 出力のタブ幅を設定する
Pygments で強調表示された Sphinx コード スニペットの HTML 出力でタブ幅を設定するにはどうすればよいですか? デフォルトでは迷惑な 8 ですが、私は 4 が必要です。Sphinx の conf.py で、この設定に関する言葉が見つかりませんでした。
python - メモのSphinxソースの場所-警告:ドキュメントはどのtoctreeにも含まれていません
下部にあるSphinxの警告をどのように修正できますか?
私は自分のPythonノートをSphinxに入れようとしています。index.rstと同じディレクトリレベルの別々のファイルにメモがあります。
HTMLをビルドした後、次の警告が表示されます
警告
の
構築時の完全なメッセージ
python-sphinx - Sphinx/reStructuredText のテーブルのエディター?
ドキュメントにSphinx / reStructuredTextを使用することを検討していますが、テーブルが面倒に見えることを除いて、非常に有望に見えます。役立つエディターはありますか?
php - Sphinx で PHP コード ドキュメントを生成しますか?
Sphinx は、一連の ReST 形式のテキスト ファイルから適切なドキュメントを生成する Python ライブラリです。全文検索に使用されるツールではない
また、doxygen / phpdoc ツールについても十分に認識しています。Sphinx を使用して PHP プロジェクトを文書化する方法があるかどうかを調べようとしていますか? または、他の非 Python 言語でさえありますか?
python - 特定のeggディレクトリを強制的に解凍します
自分で作成したPyQtアプリケーションのeggディストリビューションがあり、スフィンクスで生成されたドキュメントが含まれています。アプリケーションからヘルプファイルを呼び出すと、QtWebKit.QWebViewウィンドウでsphinxindex.htmlが開きます。どうやら、index.htmlファイルだけがeggからOSのeggディレクトリに抽出されます(たとえば、Windowsでは[..] \ Application Data \ Python-Eggs \)。
これにより、css、イメージ、リンクが壊れます。これらの他のファイルは解凍されていないように見えるためです。それらはeggファイルには存在しますが、eggディレクトリには存在しません。
私はここで何かが欠けていますか?すべてのhtml、css、画像ファイルをすぐに強制的に解凍する方法はありますか?
python - PythonSphinxドキュメントでモジュール/クラス/関数本体を文書化する
Autodoc機能を使用して関数またはクラス本体(コード自体)を出力するSphinxドキュメントを使用する方法はありますか?私はautodocを使って大成功を収めています。ドキュメントに引き込まれるドキュメントに加えて、ソースを表示する各関数のリンクをクリックしたいのですが...それは可能ですか?
これは私のドキュメントのほとんどが今どのように見えるかについてです:
ant - Ant から Sphinx を実行した人はいますか?
私はいくつかのソフトウェア ドキュメントにSphinxを使用していますが、それは非常にうまく機能しているようです... しかし、私のプロジェクトは Java プロジェクトであり、Ant スクリプトから Sphinx を実行したいと考えています。
Sphinx を呼び出すカスタム Ant タスクを作成した人はいますか?
php - PHP の外部ドキュメント、DocBook なし
PHP プロジェクトのドキュメンテーション システムが必要で、コード コメントから生成されたドキュメンテーションと外部ドキュメンテーション (ユース ケース、プロジェクト スコープなど) を統合できるようにしたいと考えていました。phpDocumentor は正確に適切な機能セットを備えているようですが、外部ドキュメントは DocBook で作成する必要があり、これは私たちのチームにとって複雑すぎます。
それが Python の場合、sphinx はこの仕事にほぼ完璧です (ReST は間違いなく docbook よりも簡単です)。外部の ReST ドキュメントを phpdoc から抽出したドキュメントと統合する方法はありますか? 外部ドキュメントを分離する必要がありますか (たとえば、外部には ReST を使用し、内部には phpdoc を使用します)。または、外部ドキュメントを管理するためのより良い提案はありますか?
python - Sphinx 0.6.3:言語モジュールが見つかりません
sphinx-quickstartで生成されたmake.batコマンドを使用しようとすると、次のエラーメッセージが表示されます。
HTMLを作成する
エラー:言語モジュールが見つかりません。Sphinxとその依存関係を正しくインストールしましたか?
sphinx-buildコマンドを実行しようとしましたが、同じエラーが発生しました。
WindowsVistaでPython2.6.4を使用しています。setuptools-0.6c11.win32-py2.6をインストールし、easy_installを使用してSphinx0.6.3をインストールしました。
cmdlineをインポートしようとすると、init .pyが失敗しているようです(エラーメッセージの一部をgrepしましたが、表示されたファイルはinittry
.pyだけでした)。これは、 cmdlineをインポートするブロックにエラーが表示されるためです。
「言語」が引数として渡される場所がわからないため、エラーメッセージで混乱します。私は解決策を探しましたが、何も見つかりませんでした。