問題タブ [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 が json を生成するのはなぜですか?
Sphinxには、JSON でドキュメントを生成する機能があることに気付きました。これらのファイルは何に使用されますか?
python - docutils と Sphinx の関係は?
Python 用のドキュメンテーション ツールはたくさんあるようです。私が遭遇した別のものはepydocです。Sphinx は、公式の Python ドキュメントを生成するために使用されているため、デファクト スタンダードのようです。誰かが私のために Python のドキュメンテーション ツールの現在の状態を整理してくれませんか?
code-snippets - Sphinx、reStructuredTextコードスニペットの表示/非表示
私はSphinxとreStructuredTextを使用してソフトウェアパッケージを文書化しています。
私のドキュメントには、長いコードスニペットがいくつかあります。それらを展開する小さな「表示/非表示」ボタンを使用して、デフォルトで非表示にできるようにしたいと思います(例)。
それを行うための標準的な方法はありますか?
documentation-generation - RestructuredTextとSphinxを使用して事前にフォーマットされたファイルを含める
私はこのフラグメントを機能させようとしています:
つまり、includeディレクティブを使用して、ファイルがブロック引用符として含まれるようにします。ブロック引用符の中に入ると、ディレクティブが引用符で囲まれます。ファイルの内容をブロック引用符で囲んでください。
これを行う方法はありますか?
python - reST の代わりに Markdown で Sphinx を使用する
reST は嫌いですが、Sphinx は大好きです。Sphinx が reStructuredText の代わりに Markdown を読み取る方法はありますか?
python - Sphinx で、常にリンクに変換する必要のあるキーワードをたくさん登録できますか?
私のドキュメント文字列には、私が定義した他の python クラスへの参照があります。Sphinx がこれらのクラスの 1 つに遭遇するたびに、そのクラスのドキュメントへのリンクを挿入したいと考えています。これはスフィンクスで可能ですか?
具体的には、次のようなドキュメント文字列があります。
私は書くことができます:
しかし、Sphinx が一致するすべてのテキストを見つけてFoo
、:class: と入力したように見せてくれることを望みます。~foo.Foo
python - Sphinx/Pygments でリテラル インクルード内の 1 行以上のコード行を強調する方法はありますか?
私が書いているいくつかのスフィンクス ドキュメントでは、次のような補助ファイルからのコード サンプルを含めています。
この特定のドキュメントは、クラスが段階的に構築されるチュートリアルです。私がやりたいのは、クラス全体または単一のメソッドを含めて、そのセクションの関心のある行だけを強調することです。こうすることで、コンテキストは保持されますが、興味深い部分は一目でわかります。今のところ、テキスト内の行番号を参照することに頼っています。これは問題ありませんが、理想からはほど遠いものです。
スフィンクスとピグメントのドキュメントとコードを見ると、これを行う明白な方法が見つかりません。私はそれらにパッチを当てたり、で何かトリッキーなことをすることに反対していませんがconf.py
、誰かがこれを解決したかどうか疑問に思いました.
python-sphinx - Sphinx: 相互参照インデックス付きアイテム
reStructuredText ドキュメント内のインデックス付きアイテムを相互参照するにはどうすればよいですか?
たとえば、セクション B を相互参照するにはどうすればよいですか。
次のような参照でインデックス ラベルを使用してみました。
しかし、これは機能しません。
latex - 最初のテーブルを LaTeX に変換する
いくつかの .rst ファイルがあり、標準の sphinx コンバーターを使用してそれらを .tex ファイルに変換します。
一部の .rst には、次のような特別な幅のテーブルがあります。
結果の .tex には、常に次のようなテーブルが含まれます。
そのため、列幅が失われます。
rst を latex に変換するときに列幅を維持するにはどうすればよいですか?
コンマ区切りも使用しましたが、
しかし、それは動作しません..多分私は悪いコンバータを使用しました? おすすめのコンバーターは?