問題タブ [read-the-docs]

RuboCop は、単一ページの README から、readthedocs.io で入手できる複数の小さなページからなるマニュアルに変更されました。すべてを 1 つのページで表示する方法はありますか? github で READMEのリファクタリングされていない最後のバージョンを表示することは、今のところ機能しますが、時間の経過とともに廃止される予定です。

reST ファイル内の別のドキュメントにリンクする方法がわかりません。

install.rstという名前のファイルを、段落内のクイックスタート ガイドにリンクしたいと考えています。どうすればこれを達成できるかわかりません。

残りの構文を検索できる優れたリソースも参照してください。デフォルトのクイックスタートは少し退屈で、sphinx での rest の使用に関する深い議論は含まれていません。

問題のドキュメントは次のとおりです。http://todx.rtfd.io

を使用してドキュメント プロジェクトを生成してReadThedocs (mkdocs)います。ただし、ディレクトリ.mdに配置されたファイルのドキュメントプロジェクトを生成しています。docs私の要件は、.mdgithub リポジトリ内の任意の場所に配置されたすべてのファイルのドキュメント プロジェクトを構築することです。

これを達成する方法は？

含まれている ReadtheDocs テーマから、プロジェクトの bootswatch United テーマに切り替えました。私はpip install mkdocs-bootswatchこのテーマを作成し、ファイルに変更theme: readthedocsしました。theme: unitedmkdocs.yml

ただし、プロジェクトは Read the Docs で正常にビルドされますが、ドキュメントは標準の readthedocs テーマを保持します。ローカルで ( を使用してmkdocs serve) 実行すると、United テーマで正しく表示されます。

どこかを調整する必要がある別のコード行はありますか? 追加する必要がある要件ファイルは? 外部テーマを ReadtheDocs に適切に表示するにはどうすればよいですか? または実際、readthedocs.org で外部テーマを使用することもできますか?

注: MkDocs の関係者に尋ねたところ、ReadTheDocs の制限であるとのことでした。そのため、何かすることがあれば、ReadTheDocs 関連の解決策になるようです。そうしないと、GitHub ページなどに切り替える必要があるかもしれません。

私はこのことにまったく慣れていません。「最も一般的に使用される」アプローチを理解するために丸一日を費やしました。私が実装したいのは、readthedocs.org のようなものですが、個人の顧客 (および独自のプロジェクト) 向けです。

ほとんどすべての FAQ、ブログ投稿、ハウツーなどで、GitHub ページまたは readthedocs.org (.com) を使用してドキュメントをホスト (公開) する方法が説明されています。

私はローカルで Sphinx (NB: "Sphinx Search" ではありません) を使用しようとしましたが、サンプルのデモ ドキュメントを非常に簡単に作成できましたが、そのような "検索可能な" ソリューションをホストする方法が正確にはわかりません。http://www.sphinx-doc.orgで動作します(ただし、検索バックエンドとして readthedocs.org を使用しているようです)。

readthedocs.org をローカルに展開しようとしましたが、次のようになります。

1. 「検索」は機能しません (誰も 127.0.0.1:9200 をリッスンしません)。
2. ドキュメントをビルドできませんでした (バージョンが見つからないか、プロジェクトが見つかりません)。
3. プライベート リポジトリ (ssh:) からプロジェクトを追加できませんでした

(注: 私は Windows で試していましたが、それは項目 1 から 2 を説明するかもしれませんが、3 は説明しないと思います。)

これまでのところ、私はアイデアを使い果たしたように感じます..

どんなアドバイスでも大歓迎です！

readthedocs のドキュメントをコンパイルするには、モジュール h5py をモックする必要があります。次の簡単なコードで再現できるエラーが表示されます。

このスクリプトの出力は次のとおりです。

h5pyをモックする正しい方法は何h5py.Fileですか?

この問題は、一部のモジュールをモックする必要がある readthedocs を使用したドキュメントでは非常に一般的であるように思えます。コミュニティが答えを持っていることは有益です。

私は問題があります。Read The Docs を手動でインストールしましたが、bitbucket に接続しようとするとエラーが発生します。

トレースバックhttp://dpaste.com/3J4AK6K。助けてください。私は何をする必要がありますか？私はpythonとdjangoで新しいです。

http://read-the-docs.readthedocs.io/en/latest/install.htmlのガイドラインに従って readthedocs をローカルにインストールすると失敗します。Mac Pro OSX El Capitan 10.11.15 にインストールしようとしています。

localhosts:8000 にアクセスしようとすると、メッセージが返されますA server error occurred. Please contact the administrator.

ターミナル出力:

この問題に精通している人はいますか？