python-sphinx

0熱

1答えて

私はスピーキングのドキュメントでナビゲートしやすくするためにinternal referencesを広く使っています。参考文献はうまく動作しますが、宛先ページの正しい位置に読者を連れていかないことに気付きました。なぜなら、ナビゲーションバーによって隠れているからです。あなたのよう：ナビゲーションバー隠しで以下の章に私の:ref:をクリックした後：以下の章を私:ref:をクリックした後ナビゲ

0熱

1答えて

スフィンクスはどこかにPythonモジュールをキャッシュしています：どこですか？

私は、Sphinxを使ってPythonモジュール用の簡単なドキュメントを作成しようとしています。初めて私が走った時、それはうまくいった。今、私はモジュールにいくつかの更新を行い、ドキュメントを再実行すると、コマンドいる： $ sphinx-apidoc -P -F -f -e -o . /path/to/module $ make html それは常にはPythonのモジュールコードの古いバージョ

1熱

1答えて

SphinxのPythonドメインで相互参照の役割を使用する

Pythonドメインの相互参照役割の使用を理解できません。具体的にはです。py：const：誰かがより明確な説明とその使用例を提供できますか？例えば、私は次のディレクティブが含まれていmodule.rstファイルがあります：PY：：CONST：SUCCESSはモジュールCommonSymbolsで定義された変数であるSUCCESS、私が期待していたドキュメントから .. default-role

1熱

1答えて

スフィンクス：最初のクラスとifconfigを組み合わせることは可能ですか？

私は、ソフトウェアのマニュアルに書いています。私は本当によく働く、さまざまなスタイルと機能を制御する別のセクションに特定のCSSクラスを追加する.. rst-cass::ディレクティブを使用しています。今私は、ドキュメントの異なるバージョンを作成しようとしましたので、.. ifconfig::で.. rst-cass::を結合しようとしました。私は、HTMLファイル、ビルドプロセスdidn't仕上

1熱

2答えて

Sphinx：Sphinxを使用してドキュメントを生成する方法

スフィンクスクイックスタートというコマンドを入力すると、何度も値を入力する必要があります。たとえば： > Root path for the documentation [.]: > Separate source and build directories (y/n) [n]: > Name prefix for templates and static dir [_]: > Proje

1熱

1答えて

SVG画像を含むSphinxドキュメントはIE11でレンダリングされません

現在、Sphinxのドキュメントを作成しており、graphvizによって構築されたSVG画像として生成されたUML図があります。このSVGファイルは、Sphinxによって自動生成されるHTMLテンプレートに置かれます。 SVGはChromeとFirefoxで問題なく表示されますが、IE11では表示されません。イメージを表示させるためにhtmlで調整しなければならないことはありますか？ところで、P

1熱

1答えて

のpython-スフィンクスautomoduleとは、私は次のように、ドキュメント文字列からドキュメントを生成するためにautomoduleとを使用してもサードパーティのモジュールからメソッド

ためのドキュメントを生成する： .. automodule:: cdbus.csdb.chemnavi.db.schema :members: しかしSQLAlchemyのため:members:それはまた、生成されるドキュメントと例コードを使用して、これは私のモジュールではありません。私はモジュールを書くためにsqlalchemyをインポートしました。 Screenshot of d

2熱

1答えて

Python docstringで異なる戻り値の型を指定する方法

現在、私はPythonパッケージのドキュメントをSphinxとautodocプラグインを使って書いています。関数の戻り値については、例えば次のようにすることができます。 :returns: int: countを書くと、countという名前のint型の戻り値があることがsphinxに伝えられます。私は今、私に私のデータベース内の項目の前任者を取得する機能を持って：あなたが見ることができるように

1熱

1答えて

Sphinxはhtml_sidebarsから1ページを除外します

私はSphinxを使ってアプリケーション用のユーザードキュメントを作成しています。ビルド設定ファイルのドキュメントによれば、html_sidebars設定にはdocumentaionという例があります。私はすべてのページが1以外のサイドバーを表示していしているよ html_sidebars = { '**': ['globaltoc.html', 'sourcelink.html', 'sear