タグ付けされた質問 「python-sphinx」

6
Sphinx autodocは十分に自動化されていません
Sphinxを使用して5,000行以上のプロジェクトをPythonでドキュメント化しようとしています。約7つの基本モジュールがあります。私の知る限り、autodocを使用するには、プロジェクト内の各ファイルに対して次のようなコードを記述する必要があります。 .. automodule:: mods.set.tests :members: :show-inheritance: 多くのファイルを持っているので、これは非常に面倒です。「mods」パッケージを文書化することを指定できれば、はるかに簡単になります。Sphinxはパッケージを再帰的に調べ、各サブモジュールのページを作成します。 このような機能はありますか？そうでない場合、すべての.rstファイルを作成するスクリプトを作成できますが、これには多くの時間がかかります。
5
Sphinxのautodocを使用してクラスの__init __（self）メソッドをドキュメント化する方法は？
Sphinxはデフォルトでは__init __（self）のドキュメントを生成しません。私は以下を試しました： .. automodule:: mymodule :members: そして ..autoclass:: MyClass :members: conf.pyで、次の設定は__init __（self）docstringをクラスdocstringに追加するだけです（Sphinx autodocドキュメントはこれが予想される動作であることに同意しているようですが、私が解決しようとしている問題については何も言及していません）。 autoclass_content = 'both'
7
sphinx-buildが失敗する-autodocがモジュールをインポート/検索できない
私はSphinxを使い始めようとしていますが、容赦ない問題があるようです。 コマンド： docs/sphinx-quickstart 私はすべての質問に答え、すべてがうまくいきます。 コマンド： docs/ls すべてが正常に見えます。結果：build Makefile source コマンド： sphinx-build -d build/doctrees source build/html 動作するようです。index.htmlファイルを開いて、必要なものの「シェル」を表示することができました。 実際のソースコードをsourceフォルダーとして配置しようとすると、問題が発生します。 コマンド： sphinx-build -d build/doctrees ../ys_utils build/html 結果： Making output directory... Running Sphinx v1.1.3 loading pickled environment... not yet created No builder selected, using default: html loading intersphinx inventory from http://docs.python.org/objects.inv... building [html]: targets …
5
Doxygenを使用してPythonコードを文書化する方法[クローズ]
クローズ。この質問はもっと焦点を合わせる必要があります。現在、回答を受け付けていません。 この質問を改善したいですか？質問を更新して、この投稿を編集するだけで1つの問題に焦点を当てるようにします。 2年前に閉鎖されました。 この質問を改善する 私はDoxygenがCまたはPHPコードのドキュメントを作成するのが好きです。私は今後のPythonプロジェクトを持っていますが、Pythonには/* .. */コメントがなく、Pythonのように文書化する独自の自己文書化機能もあることを覚えていると思います。 私はDoxygenに精通しているので、それを使用してPythonドキュメントを作成するにはどうすればよいですか？特に気をつけなければならないことはありますか？
2
reStructuredTextでネストされたリストを作成するにはどうすればよいですか？
次のコードを使用して、適切にネストされたリストを作成しようとしています（Sphinxおよびdocutilsのドキュメントに従ってください）。 1. X a. U b. V c. W 2. Y 3. Z これにより2OL秒になると思いますが、代わりに次の出力が得られます。 <ol class="arabic simple"> <li>X</li> </ol> <blockquote> <div> <ol class="loweralpha simple"> <li>U</li> <li>V</li> <li>W</li> </ol> </div> </blockquote> <ol class="arabic simple" start="2"> <li>Y</li> <li>Z</li> </ol> 私は何が間違っているのですか？次のような結果は得られませんか？ <ol class="arabic simple"> <li>X <ol class="loweralpha simple"> <li>U</li> <li>V</li> <li>W</li> </ol> </li> …
6
sphinxは、ルートドキュメントの下のディレクトリにないドキュメントにリンクできますか？
私はSphinxを使用してPython以外のプロジェクトを文書化しています。./doc各サブモジュールに、submodule_name.rstそのモジュールを文書化するためのファイルを含むフォルダーを配布したいと思います。次に、これらのファイルをマスター階層に吸い込んで、デザイン全体の仕様を作成します。 すなわち： Project docs spec project_spec.rst conf.py modules module1 docs module1.rst src module2 docs module2.rst src 次のproject_spec.rstように、マスタードキュメントのtoctreeにファイルを含めようとしました。 .. toctree:: :numbered: :maxdepth: 2 Module 1 <../../modules/module1/docs/module1> ただし、次のエラーメッセージが表示されます。 警告：toctreeには、存在しないドキュメントu'modules / module1 / docs / module1 'への参照が含まれています ../どういうわけかドキュメントパスで使用することはできませんか？ 更新：conf.pyの場所を追加しました 更新：以下のインクルードトリックを除いて、これはまだ（2019）不可能です。前進し続ける未解決の問題があります：https：//github.com/sphinx-doc/sphinx/issues/701
3
Pythondocstringのクラスメソッドへのリンク
同じクラスの別のメソッドのdocstring内から、クラスのメソッドへのリンクを追加したいと思います。リンクをsphinxで機能させ、優先的にSpyderやその他のPythonIDEでも機能させたい。 私はいくつかのオプションを試し、うまくいくものを1つだけ見つけましたが、それは面倒です。 次の構造を mymodule.py def class MyClass(): def foo(self): print 'foo' def bar(self): """This method does the same as <link to foo>""" print 'foo' 私は次のオプションを試しました<link to foo>： ：func： `foo` ：func： `self.foo` ：func： `MyClass.foo` ：func： `mymodule.MyClass.foo` リンクを効果的に生成するのは：func： `mymodule.MyClass.foo`だけですが、リンクはとしてmymodule.MyClass.foo()表示され、foo()またはとして表示されるリンクが必要fooです。 上記のオプションはいずれもSpyderでリンクを生成しません。 ご協力いただきありがとうございます。
4
reStructuredTextのリンクのテキストをフォーマットする
reStructuredTextの指定されたリンク内のテキストをどのようにフォーマットしますか？ 具体的には、最初から次のHTMLを生成したいと思います。 <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> 結果は次のようになります。 optparse.OptionParser ドキュメンテーション ここで、「optparse.OptionParser」部分は固定幅フォントです。 私は試した ```optparse.OptionParser`` <http://docs.python.org/library/optparse.html>`_ しかし、これは <tt class="docutils literal">`optparse.OptionParser</tt> documentation <<a class="reference external" href="http://docs.python.org/library/optparse.html">http://docs.python.org/library/optparse.html</a>>`_ このように見えます `` optparse.OptionParser documentation <http://docs.python.org/library/optparse.html>\_
1
「pip._internal.index」から「PackageFinder」という名前をインポートできないため、Read-the-docsビルドが失敗する
read-the-docsでのSphinxドキュメントのビルドは、次のエラー（以下の完全なログ）で失敗します。 ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py) 私は何か間違ったことをしたのですか、それともドキュメントのバグですか？ Sphinxドキュメントのローカルビルドは問題なく実行されます。 read-the-docsの完全なエラーログ： Read the Docs build information Build id: 10299638 Project: cascade-python Version: latest Commit: a7d50bf781bd8076b10dd7024db4ccb628016c27 Date: 2020-01-21T17:03:12.876711Z State: finished Success: False [rtd-command-info] start-time: 2020-01-21T17:03:13.203354Z, end-time: 2020-01-21T17:03:13.215400Z, duration: 0, exit-code: 0 git remote set-url origin https://github.com/brunorijsman/cascade-python.git [rtd-command-info] start-time: 2020-01-21T17:03:13.276220Z, end-time: …
2
疑問符を含む最初のファイルから変換されたhtmlファイルがカタログをクリックするとブラウザに表示されないのはなぜですか？
ファイルsimple.7zをダウンロードし、sphinxにインストールして、ここで説明した問題を再現してください。再現するには、次のコマンドを実行します。 make clean make html 問題を再現するには、sphinxにダウンロードしてインストールします には2つの記事がsample/sourceあり、内容は同じですが、タイトルだけが異なります。 cd sample ls source |grep "for-loop" What does "_" in Python mean in a for-loop.rst What does "_" in Python mean in a for-loop?.rst 1つはその中に含まれ?、もう1つは含まれません?。実行後に奇妙なことが起こりましたmake html。 make html ls build/html|grep "for-loop" What does "_" in Python mean in a for-loop.html What does "_" …
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.