python-sphinx

    13

    1答えて

    私は現在、Pythonで書かれたrest APIを文書化しています。すべてのプロジェクトのドキュメントはSphinxを使用して作成され、REST APIのためにいくつかの特別なディレクティブを作成したいと考えています。たとえば、このリソースが定義されているとしましょう: @resource("/user/<email>", method="GET") def user_details (emai

    5

    1答えて

    私はSphinxを使ってPythonプロジェクトを文書化しています。キャンバスを使用して、ドキュメントのいくつかの結果を視覚化しています。私の文書はFirefoxとIEをサポートする必要があります。ドキュメントにexcanvas.jsライブラリを含める必要がありますが、ブラウザーがIEの場合に限ります。このライブラリを条件付きで含めることで、相対パスが正しいようにするにはどうすればよいですか?ノー

    8

    4答えて

    私はSphinxを使っていくつかのドキュメントを生成しています。私はreStructuredTextドキュメントを持っていて、それにイメージを入れたいと思います。この場合、ユーザーが画像をクリックした後に画像をフルサイズで表示するように、画像をクリック可能にする必要があります。私はこのようなイメージディレクティブとそのターゲットのオプションを使用します。 .. image:: /images/so

    9

    2答えて

    sphinxにRTL(右から左、farsi、arabic、...のような)テキストを使用する方法はありますか? .rstファイルからhtmlを生成するとき、生成されたhtmlはLTR(デフォルトでは左から右)で左に揃えられ、私はそれをどのように変更してRTLにし、右揃えにするのです。 ご返信ありがとうございます。

    5

    3答えて

    これで解決できる最終的な問題はTeX(PDF出力のための新しいフォントをインストールする)ですが、私が探しているこの特定の解決策はSphinxの問題です。 SphinxはPDFを作成する際に標準のLaTeXを使用していますが、これまでのところうまくいきましたが、新しいフォントをインストールして試してみる必要があります。 これはXeLateXを使用する方がはるかに簡単なプロセスなので、XeLaTeX

    14

    3答えて

    私は、Tastypie REST API用のAPIドキュメントを生成するために自動ドキュメントツールを使用しようとしています。私はtastytoolを試しましたが、APIの結果パラメータではなく、モデルの列が表示されているようです。その後、SphinxはSphinxをサポートしているので、Sphinxはより有望に見えましたが、コード内にAPIのコメントを入れて文書に生成する方法を示す例は見つかりま

    10

    1答えて

    一部のreStructuredTextにカラースパンを追加する方法について説明しているa previous questionがあります。 手順を要約すると: まず、役割があります。 .. role:: red An example of using :red:`interpreted text` 以下のように変換されます。 <p>An example of using <span clas

    20

    1答えて

    私は多くの.rstファイルを私のSphinxツリーにあり、意図的にインデックスツリーから除外しています。 /filename.rst:: WARNING: document isn't included in any toctree スフィンクスの特定の警告を抑制するにはどうすればよいですか?

    9

    3答えて

    Sphinx(Pythonドキュメントジェネレータ)の出力結果は、多数のHTMLファイルになります。一人一人には、JavaScriptとCSSの数が多いとのヘッダーが含まれています: <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> <link rel="stylesheet" href="../_

    6

    2答えて

    私はhtmlドキュメントを作成したいと思っているかなり大きなコードベースを継承しました。 Pythonで書かれているので、私はsphinxを使用することに決めました。なぜなら、コードのユーザーはsphinxで作成されたpython-documentionの設計と機能に慣れているからです。 私はsphinx-apidocというコマンドを使って自動的に最初のファイルを作成しました。私はsys.path