python-sphinx

1熱

1答えて

私はSphinxドキュメントのPythonプロジェクトを持っており、コードリポジトリを小さく保つために、ドキュメントに含めるイメージやファイルのいくつかは別のリポジトリにあります。 Sphinx docsビルドでは、他のリポジトリを指すようにシェル環境変数を設定しています。私はこのようなimage directiveからそれを使用してみました： .. image:: $OTHER_REPO/doc

1熱

1答えて

私はスフィンクスを使ってpdfを作成します自動インデックスを生成する方法

スフィンクスは一般的なインデックスと言語固有のモジュールインデックスを使用できますが、私はスフィンクスを使ってpdfを生成します。

2熱

1答えて

あるディレクティブを別のディレクティブに置き換えることは可能ですか？

ディレクティブを別のディレクティブに変換する代替（または同様のもの）を作成したいと思います。例えば：たちのスフィンクスベースのドキュメントでは、我々は特定のノートと警告ボックスを作成するためにAdmonitionsを使用しています。我々は .. note:: This is a Note を使用する場合は、ボックスのタイトルは注、およびこれは注意あるが、最初の段落になっています。これとは

0熱

1答えて

スフィンクス - toctreeとコンテンツの違いは何ですか？

私は、2つの方法で目次を作成することができます .. contents:: :local: depth: 1 または .. toctree:: :maxdepth: 1 index 違いは何ですかとして？私はどこでtoctreeを使うべきか、内容はどこですか？

2熱

1答えて

翻訳されたSphinxドキュメントを別のディレクトリに構築する

私は別の言語で公開されるドキュメントを作成しています。それが私がスフィンクスを使う理由の一つです。翻訳版の作成方法はわかりますが、documentationに記載されている設定では、以前に生成されたものが置き換えられます。したがって、複数の翻訳を生成する場合は、他の作業を行う前にファイルを別のディレクトリに移動する必要があります。別々のディレクトリに翻訳を生成する方がより現実的です（展開が簡単で

2熱

1答えて

自動Ansibleドキュメンテーションはどのように機能しますか？

これは私の状況です：私は、巨大なプロジェクトディレクトリの中で、無責任なプレイブックと役割を書いています。現在、私のドキュメントは.mdファイルに保存されています。しかし、私はAnipalのドキュメントメカニズムを使いたいので、私はsphinxドキュメントシステムを調べました。それは私にはきれいに見えるので、私はそれをインストールし、メカニズムに入った。しかし、私は理解できません：どのようにA

0熱

1答えて

サブセクションをPythonでモックする

私は自分のプロジェクトのオートドキュメントをsphinxで生成しようとしています。しかし、私はインポートするすべてのモジュールを持たない環境でautagersの世代を実行します。それゆえ、私は輸入声明を模倣したいと思う。私はCモジュールのこのトリックを見つけhttp://read-the-docs.readthedocs.io/en/latest/faq.htmlで： import sys f

0熱

1答えて

スフィンクスの文書に辞書をリストアップする

私はいくつかの辞書を含むいくつかの.pyファイルを持つプロジェクトを持っています。このように： # My file dictionary = {'key1': 'value1', 'key2: 'value2'} しかし、はるかに大きく、長く、私はこれをスフィンクスで文書化したいが、正しく動作させることはできない。ファイルはSphinxで見つけられ、Modulesの下にfolder.fil

3熱

1答えて

親モジュールでインポートされ、文書化された継承されたオブジェクトのSphinx相互参照の破損

私はSphinxドキュメントのビルドを正しく行い、相互参照（継承された関係からの継承を含む）を正しく実行しようとしています。私は、クラスAとBを宣言し、a.b.__init__で $ tree . . ├── a │ ├── b │ │ └── __init__.py │ └── __init__.py ├── conf.py ├── index.rst └── R