問題タブ [read-the-docs]

Sphinx ドキュメントをReadtheDocsにリンクしようとしています。ドキュメントをローカルでビルドすることはできますが、ReadtheDocsにドキュメントを自動的に生成させようとすると、次のエラーが発生します。

スフィンクスの標準エラー

私のプロジェクト名は mousedb です。自動ビルドではこのインポート エラーが発生するのに、ローカルでは発生しない理由がわかりません。

アップデート

コメントに基づいて、これは設定ファイルを兄弟Docsディレクトリにインポートする際の問題だと思います。(私が行っていたように) 絶対インポートを行うのではなく、 と の場所に基づいて相対インポートを行う必要がsettings.pyありconf.pyます。

conf.py次のディレクトリ構造を使用して、設定ファイルを my にインポートしたいと考えています。

プロジェクトのドキュメントを (Python docstrings で) 書き、ローカル コンピューターで Sphinx を使用してすべてをテストしました。すべて正常に動作し、すべてのインポートが正しく動作するなどです。Python 3そこで、Read The Docs (とnumpydoc私のライブラリ) にカスタム環境をセットアップし、docsディレクトリ (およびdocs/sourceサブディレクトリ) を Github リポジトリに追加しView Docsました。 Nginx 404 ページ)。ログは次のとおりです。

私のconf.py持っている

automoduleそのため、不明なディレクティブとしてリストされている理由がわかりません。

利用時にサイドバーに自動生成された目次へのリンクが欲しいsphinx-rtd-theme。私はそれをtoctreeに追加しようとしました:

しかし、これは

スフィンクスから、他の効果はありません。

単純にテーマ ファイルにインデックスをハードコードすることもできると思いますlayout.htmlが、標準のテーマを変更する以外に、もっと良い方法があるのではないでしょうか?

ヒントはTIAまで！

指示へのリンク

http://read-the-docs.readthedocs.org/en/latest/install.html#solr-search-setupの指示に従っています

質問

現在、readthedocs.org のローカル インスタンスをセットアップできます。ただし、次のコマンドを実行しても必要な schema.xml ファイルを生成できないように見えるため、検索を正しく設定できません。そのコンテキストは上記のリンクにあります。

schema.xml を正常に生成する代わりに、このエラーが表示されます。

xmlを生成する前に、djangoでsolrを構成するための追加のステップがあると思います。同様のエラーは、settings.py ファイルの編集を示唆していますが、プロジェクト ディレクトリ内にファイルが見つからないようです。私は django に慣れていないので、ここから先に進む方法がわかりません。

ドキュメントの複数の「レベル」をドキュメント化する方法でスフィンクスを使用しようとしています。

• API リファレンス
• マニュアル
• チュートリアル
• 等。

目次は、現在のセクションに関連するサイドバーに表示されるという考え方です。したがって、メインのインデックスにいるときは、上記のセクションのみが表示されます。あなたが入るとき。「マニュアル」は、そのセクションに固有の別の目次と、メインの目次に戻る方法を示しています。

ハッキングせずにSphinxでこれを機能させる方法を見つけようとしていますが、今のところ方法がわかりません。フォルダー構造はすでにさまざまなセクションを反映しており (つまり、すべての「マニュアル」ドキュメントは _source/manual の下に保存されています)、これらの各ディレクトリに個別のインデックス ファイルを配置しようとしましたが、toctree 機能はメイン インデックス ファイル。

「readthedocs」テーマを使用しています。具体的に見ているコードはhttps://github.com/snide/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html#L93です

Sphinx を使用してこのような ToC を追加する方法を誰か教えてもらえますか?

ありがとうございました

plot-directiveを使用してmatplotlib のダイアグラムをオンザフライで生成および埋め込むpython-3プロジェクトがあり、プロジェクトのドキュメントを自動生成するためにReadTheDocsを使用しています。 プロット ディレクティブは確かに python-2では正常に動作しますが、現在 python-3 では失敗しています。

具体的には、RTD のログに表示されるエラーは次のとおりです。

ビルド標準エラー

そして、犯人は、「freetype」C lib を mniss したためにコンパイルされていない matplotlib にたどることができます。

セットアップ出力

doc-generation パスを作成するには、RTD FAQで指示されているように、ファイル内の次のコードを使用して、プロット ディレクティブをモックアウトして "無効にする" 必要があり./conf.pyます。

virtualenv（サイトパッケージの可視性の有無にかかわらず） rtd-specificのさまざまな組み合わせを試しましたがrequirements.txt、成功しませんでした。

誰かがそれを行う方法を見つけましたか?

これらは、問題をさらに掘り下げたい人のためのヒントです。

• RTD にプリインストールされているネイティブ ライブラリの「公式」リスト
• RTDのソースから見つけた、ビルド サーバーのセットアップに使用される実際のファイル。pip-requirements.txt

画像を表示するために、幅または高さの修飾子なしでエイリアスを使用します。

この画像は、装飾なしで正しくレンダリングされます。

高さ修飾子を追加して、この画像のサイズを変更します。

これを行うと、私の readthedocs ページには、この画像の下に灰色の線が表示されます。

何が起こっているかというと、アンカー タグが (何らかの理由で) この画像のタグに巻き付けられてimgおり、アンカー タグにはテキスト装飾スタイルが適用されており、灰色の下線が追加されています。

これを防ぐにはどうすればよいですか？マウスオーバー時に画像をダウンロードする必要はありません。画像を表示したいだけです。