python-sphinx

1熱

1答えて

素晴らしいSphinxツールを使用してドキュメントを作成しています。同じパートの章を別々のファイルに分けることで、コードベースをモジュラー形式に保ちようとしています。 .. toctree:: :maxdepth: 2 test1 test2 ：彼らはこのような index.rstに含まれている ********* Chapter 2 *********

0熱

1答えて

Sphinxでは、モジュール内にあるが、クラスとメソッドの外にあるドキュメントストリング/コメントを含める方法

私のパッケージにはutilsモジュールがあります。インスタンス化を必要としないスタンドアロンのいくつかのメソッドで構成されています。私のような、このutilsファイル内のいくつかの一般的なコメント/ドキュメンテーション文字列を配置したいと思います：上記からわかるように import os import json """ Miscellaneous methods that help in

0熱

1答えて

Sphinx：パラメータと同じ属性を文書化してください。

numpyスタイルのdocstringでこれをドキュメントしたいと思います。属性とパラメーターは同じです。繰り返すことはできませんか？

0熱

1答えて

bulletlist sphinxのカスタムチャット

スフィンクスのデフォルトの「disc」/「circle」を変更するにはどうしたらいいですか？私はhttps://groups.google.com/forum/#!topic/sphinx-users/fNWyyRzoa8Iのソリューションのようなものを試しましたが、htmlやCSSの構文に慣れていない可能性がありますので、私にとってはうまくいきません。 _static /のcustom.css：

2熱

1答えて

異なるサブモジュールの関数/クラスへのクロスレフェンスリンク

単純な例として、次の2つのサブモジュールのコード（a.pyとb.pyは同じディレクトリにあります）。同じサブモジュール関数:func:`hook`へのリンクは動作しますが、リンクは異なるモジュールにクロスリファレンスしません。すなわち、:func:`foo`です。私も:func:`.a.foo`の構文を試しました - まだ動作しません。 a.foo()への参照はどのようにすればいいですか？ # s

0熱

1答えて

サブディレクトリにあるときにipynbファイルをsphinx index.rstに入れる

1熱

1答えて

1つの長いページを作成することなく、Sphinxでパーツ/チャプター構造を保持する方法は？

私は、複数のファイルにわたって部品/章などを含むモジュラー形式で文書を維持することが可能であることを知りました。by using the include command このアプローチの唯一の問題は、含まれているすべてのファイルを1つの大きなファイルに効果的に連結することです。つまり、それらはSphinx Read The Docs themeによって別のページとして処理されなくなります。この結果

1熱

1答えて

Sphinxスタイルのドキュメントストリングにハイライトまたはコードブロックを挿入するにはどうすればよいですか？例えば

： def foo(): ''' .. highlight:: python import sys ''' は（それはそのまま単語「ハイライト」を印刷し、特別な方法で次のコードをフォーマットしない）は、所望の出力を生成しません。 code-blockでも同じです。どのようなものであっても、ジェネレータはほぼ同じで出力は成功しますが、希望する出力は成功し