autodoc

1熱

1答えて

sphinx-apidocはサブモジュールをピックアップしますが、オートドックはそれらを文書化していません

私はPyQt5（ここでは、https://github.com/MaVCArt/StyledPyQt5）のプロジェクトで作業しています。私はこれまでSphinxでコードを文書化してきましたが、少なくともパッケージ構造を導入するまでは成功しました。（以前はすべてが1つのフォルダにありました）問題は次のとおりです。私がsphinx-apidocを実行すると、すべて正常に動作し、エラーは発生しません

1熱

1答えて

apidocでsphinx-apidocのモジュールの代わりにパッケージを使う方法

私はdocstringsを使ってpythonコードを文書化し、sphinx-autodocを使ってapidoc HTMLを生成しています。私のパッケージの構造は以下の通りです：mainpackage.subpackage.module、私はapidocsをではなくmainpackage.subpackage.Classというモジュールのクラスにリンクさせたいと思います。私の問題は、例えば、scik

0熱

1答えて

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

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

3熱

3答えて

autodocと組み合わされたreadthedocsでPython 3.5の構文を使用するには？

readthedocs.orgを使用して私のプロジェクト用のドキュメント（自動生成されたドキュメントを含む）を生成したいと思います。しかし、私のプロジェクトではPython 3.5の構文（asyncとawait）が使われていて、それを扱うことはできません。ビルドは成功しますが、次のようなエラーが発生します。 /home/docs/checkouts/readthedocs.org/user_bui

0熱

1答えて

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

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

4熱

1答えて

Sphinx-doc TOCがRTDテーマで更新しない

Read-The-Docsテーマを使用してプログラムで生成されたsphinx-docソースがあります。私が最初にしてソースをビルドするとき .. toctree:: :maxdepth: 1 models/1lin/index models/2lin/index ... ： .. toctree:: :maxdepth: 2 m

0熱

1答えて

djangoエラーのあるAutodoc Sphinx

autodocでhtmlを作成しようとするとエラーが発生します。ここでは私のプロジェクト構造である： projet --- app1 ------ models.py ------ views.py --- app2 --- app3 docs --- modules ------ models.rst --- conf.py --- index.rst __init__.

5熱

1答えて

'autodoc_default_flags'はPythonのSphinx設定でどのように機能しますか？

私はPythonクラスのドキュメントをSphinx 1.4とsphinx-apidocとsphinx.ext.autodocという拡張子を使って生成しようとしています。私はたくさんのモジュールを持っていますが、それぞれクラス名を表示するだけですが、クラス内のメソッドの完全なリスト（コード内にdocstringがあります）は表示しません。ここでは私conf.pyファイルの抜粋です： sys.pa

0熱

1答えて

オートドックdocstringでコードを実行

Sphinxとオートドックを使用してPythonプロジェクトをドキュメント化する場合、:Example:を使用して、モジュール/クラス/関数docstringにコードサンプルを組み込むことができます。そういうもの。 >>> rng = Range(0, 1000) >>> rng [0, 1000) >>> len(rng) 1000 >>> rng.start = 500 >>> r

7熱

1答えて

スフィンクスで自動的にdocクラスのToctreeを作成する

私のライブラリの1つでドキュメントを増やす予定です。私はドキュメント作成のためにsphinxを使っていましたが、最近はautodoc拡張を探っていました。ほとんどのプロフェッショナルなドキュメントのように、各クラスのドキュメントページには、すべてのドキュメント化されたメソッドのリストがあり、上部にリンクがあります。つまり、最上位のtoctreeには、それぞれ深いメソッドのドキュメントへのハイパー