問題タブ [read-the-docs]

私の理解では、新しい Read The Docs テーマは toctree から深さ 2 のサイドバーを生成します。私のドキュメントは比較的深く、深さ 2 では十分ではありません。どうすればこの制限を増やすことができますか、できれば完全に削除できますか?

それが合理的に不可能な場合、グローバル toctree の代わりにローカル ToC を使用するにはどうすればよいですか?

私のプロジェクト ドキュメントは、http://nsetools.readthedocs.org の readthedocs.org でホストされています。readthedocs でホストされ
て
いるドキュメントで Google アナリティクスを使用することは可能ですか? HTML は私が生成したものではないため、Google アナリティクスのコード スニペットをどこに適用すればよいかわかりません。

文書化された 2 つのグローバル スペシャル メンバーを含むモジュールがあります。

Sphinx をローカルで実行すると、ドキュメントを含むドキュメントが作成されますが、Read the Docs は作成されません。代わりに、組み込み型のドキュメントを使用します。

私は両方のスタイルを試しました:#:定義の後に docstring 。私は のドキュメントを何度も読んだことがautodocあります。Read the Docsにビルドエラーさえ表示されないため、何が欠けているのかわかりません。

何か案は？

使用時にメニューの順序を変更する方法を知っている人はいます.mdか? 見つからない。のような他のタイプでも可能であることは知っていますが.rst、使用します.md

ありがとうございました！

sphinx.ext.apidocプロジェクトの docstring からドキュメントを抽出する.rst ファイルのセットを構築したプロジェクトがあります。

これらのファイルは次のようになります。

make html私のコンピューターでドキュメントを適切にビルドしますが、conf.pyファイルを編集してプロジェクトを python システム パスに追加する必要があります。

ただし、readthedocs でドキュメントを作成しようとすると、autodoc が参照されているモジュールを見つけることができません。これは、autodoc がプロジェクト モジュールを適切に見つけるために、python システム パスに追加する必要があるパスがわからないためです。

ローカル環境で autodoc を使用して .rst ファイルを事前にビルドして、autodoc への呼び出しが含まれないようにし、それらを readthedocs にアップロードして、実行する必要がないようにすることができるかどうか疑問に思っていました。そこのautodoc拡張機能。

これを行う方法がない場合、その問題を解決する適切な方法は何でしょうか?

ReadTheDocs に任意のモジュールの :members: を表示させることができないようです。たとえば、ローカルの html で次のように表示されます。

しかし、githubにプッシュした後、readthedocsドキュメントには次のようにしか書かれていません:

エラーは表示されず、ローカルで html にビルドすると、警告なしで実行されます。

どんなヒントでも大歓迎です！

API ドキュメントの実装を構築するために RTD をテストしているので、debian VM 内の virtualenv で RTD のローカル インストールを実行しています。./manage.py runserver コマンドは、RTD サーバーを正常に実行します。

ラップトップ ブラウザー (VM の外部) から RTD 管理コンソールにアクセスするには、localhost をパブリック IP に変更したいと考えています。そのために、次の IP 参照を変更しました。

• /etc/ホスト
• settings/sqlite.py (セクション Internal_ips、およびその他のいくつかのオカレンス)

ただし、http: //127.0.0.1 :8000 / でサーバーを構築し続けます。

これはどこで設定すればよいですか? 他に何をすればいいですか？

ドキュメントを読むのhtmlテンプレートのソースコードを取得する方法は? git ハブから sphinx パッケージを取得しましたが、python やそのパッケージの進め方がわかりません

そのテンプレートの HTML ファイルと css ファイルが必要なだけで、必要に応じて変更します