python-sphinx

    6

    3答えて

    私は静的なスフィンクスドキュメントを(make htmlを使用して)ローカルに構築しました。 私は今、Flaskで動作するWebアプリケーションにSphinxファイルを統合したいと考えています。 Flaskを実行しているアプリケーションからは、アプリケーションのヘルプとして役立つ、Sphinxのドキュメントへのハイパーリンクを含めることを意味します。 Websupportのように見えますが、どのよ

    12

    1答えて

    私はsphinxで生成されたドキュメント(automodules機能を使用しています)を持つpythonパッケージを持っていて、プロジェクトのgitリポジトリの_buildディレクトリにある静的なHTMLページのセットにすることができます。私はかなりこのドキュメントを表示したいと思いますプライベート way on bitbucket。 git repoそのものであるwikiは、それに使えるかもしれ

    9

    1答えて

    可能性の重複: Sphinx — combining automodule and autoclass 私はスフィンクスを使用して、数千のクラスを含むプロジェクト用のHTMLドキュメントを作成しようと、それはautodocのプラグインです。 sphinx-apidocは素晴らしい最初のファイルを作成しますが、オートクローズとの自動作成が欠けています。自動作成方法 ドキュメントにすべての変数、関数、

    6

    4答えて

    RSTファイルに存在するサブセクションの1つ(またはすべて)をメインのTOCツリーから隠すことはできますか? は私はもう少し説明してみましょう: file.rst 子供/ Children Title ============== .. toctree:: Label of Grandchildren 1 Label of Grandchildren 2 Subs

    8

    1答えて

    Sphinxで作成した私のWebページにメタデータ(キーワード、説明、著者)を挿入したいと思います。 私はスフィンクスのドキュメントの :fieldname: Field content を見つけましたが、私はそれを使用する方法は考えています。 助けてください!どうもありがとう!

    20

    1答えて

    私は文書を書いており、pdfファイルやzipアーカイブへのリンクを含めたいと思います。どのように私は最初の言語とスフィンクスを使用してそれを達成することができますか? 私は、コンパイル時にスフィンクス(私はスフィンクス、クイックスタートによって生成されたメイクファイルを使用)docディレクトリの含まれをコピーしていない、ので here is a pdf file : `pdf <doc/mypdf

    10

    2答えて

    私はAPIドキュメントを生成するためにSphinxdocを使用しています。私はdocstringを書くときにpep8準拠の問題に遭遇しました。まだそれをにURLを維持しながら あなたは以下を参照することができますとおり、OWASPサイトへのリンクは、URLをラップする方法はありmaximum-line-length def handle_csrf(...): """The general

    8

    1答えて

    私はスフィンクスで何か基本的なことを試みています。私はいくつかの画像を持っていますが、私はそれらをかなり小さく保つことを好みます、そして、私はユーザーがそれらをクリックして大きな画像を得ることを許可したいと思います。 image:またはfigure:をref:またはlink:と組み合わせる構文的な方法はありません。 .. image:: _static/my_image_small.png と

    11

    2答えて

    htmlドキュメントを作成する際に、存在しないリンク上でスフィンクスに報告したり、エラーを作成したりするにはどうすればよいですか? 具体的には、Pythonプロジェクト内で削除または名前を変更したプロパティとメソッドがあり、sphinxで生成されたhtml出力を持つすべての無効なリンクを見つけることは難しいです。 私はここの答えを見つめているように感じます: http://sphinx-doc.o

    10

    1答えて

    スフィンクスのautomoduleは何かが見つからない限り、そのモジュールに定義されているクラスの属性ではなく、モジュールのメンバーだけを記録します。 は自動的方法 私は自動的にモジュールのメンバーとそのモジュールで見つかったすべてのクラスの属性のドキュメントを取得することができ、このような方法で結合automoduleとautoclassの動作を取得ありますか? 私はこれをすべてスクリプトできま