python-sphinx

1熱

1答えて

同じソースファイルの置換ルールを定義する長い名前のPython Sphinx/restの置き換え

投稿Python Sphinx referencing long names長いクラス名の代入ディレクティブに関して、私が探していたものに非常に近い答えが1つありました。 def exampleFunction(): '''Here is an example docstring referencing another |ReallyLongExampleClassName|

0熱

1答えて

sphinxからjinja2に渡される変数を見つける

私はsphinxでテンプレートを作成しようとしています。私の意図は、基本テンプレートを使用するのではなく、最初から新しいテンプレートを作成することです。しかし、どの変数がsphinxからテンプレートに渡されるかについては、ほとんど（/ no）ドキュメントがありません。テンプレートに渡されるすべての変数をsphinxからダンプしたいと思います。（理想的には、私のPythonの知識が良くないのでテ

1熱

1答えて

ipythonノートブックをスフィンクス文書に埋め込みました

私自身のプロジェクトのためのAPI文書を書いています。そして私はこの涼しいことがわかりましたdocumentation（ytプロジェクト）は、例を与えるためにipythonノートブックを直接使用しています。しかし、もちろん、それは私のために動作しませんでした .. notebook:: An_example_notebook.ipynb ：私はビットバケット上の文書レポに見えたとき、1つの関

2熱

1答えて

Django REST Swaggerを使用して静的HTML文書を生成できますか？

私は新しいDjango REST Frameworkプロジェクトに取り組んでいます。私はDjango REST Swaggerを使用して、すぐに美しいドキュメントを提供しています。しかし、ステージングマシンなどをスピンアップすることなく、このドキュメントを共有したいと思います。私はちょうど派手なクライアントの機能なしに静的なスフィンクスのようなドキュメントを生成したいと思うでしょう。実際にAPIの

0熱

1答えて

matplotlibからのハイパーリンクを抑制する

sphinxのmatplotlib.sphinxext.plot_directive拡張子を使用して、いくつかのドキュメントでいくつかのプロットを動的に作成しています。私.rstのいずれかのファイルでは、私は、これは、本質的にちょうどいくつかのmatplotlibコード、例えばを実行し、次のコマンド .. plot:: plots/normal_plots.py を持っています plt.plo

1熱

1答えて

リテラルブロック内のイメージ

私は、何かがフォルダであることを示すイメージを持つ私のドキュメントにディレクトリ表現をしようとしています。現在、私はmonospacedフォントを得るためにリテラルブロックを使用していますが、イメージを置くことはできません。正しい方法は何ですか？ RST： Look at these folders:: projects └─ BigBang ├─ |folder_img| tes

0熱

1答えて

マークアップは空白行なしで終了します。しかし、マークアップはコメント内のものだけです

私のpythonコードを文書化するときに、私はデコレータをマークして、docstringも更新することにしました。関数にドキュメントがあるのに、スフィンクスが文句を言わずにdeprecatedのドキュメントが正しく表示されない場合、これはうまく動作します。私は同等のコードにまで問題を縮小している：スフィンクスはWARNING: Explicit markup ends without a bla

0熱

1答えて

スフィンクス検索ページの深さを増やすことはできますか？

上記の画像は、Sphinxドキュメントジェネレータの検索機能です。画像からわかるように、検索ページにはDefinitionsとOrdersの下に「オブジェクト」が表示されません。検索結果を一層深くする設定がありますか？

1熱

2答えて

Cucumber/Gherkinからドキュメンテーションを生成するには？

私はrelishapp.comのアイデアが好きです。つまり、キュウリ/ゴーキンの機能があり、それらから "生きているドキュメント"を生成しています。しかし、Relish SaaS is awful。私は代わりの方法を探しています。理想的には、自己ホスト型のオープンソースSphinxのようなホストだが、私はSaaSソリューションに完全に反対していない。特にスフィンクスは他のドキュメントと組み合わせ

1熱

1答えて

別のドキュメントにドキュメントを含めるためのsphinxディレクティブは何ですか？私のドキュメントで

は、私が言うことができるexamplesディレクトリ、彼らはコードだと、彼らはコードとして正しくフォーマットしているので、素晴らしい作品..which .. literalinclude:: examples/1_basic_usage.py :language: python :linenos: を持っています。ただし、非コード文書でliteralincludeを実行し