問題タブ [read-the-docs]

私のプログラムのドキュメントは主にSphinxで書かれていますが、2 つのカスタム HTML ページも含まれています。

• プログラムによって作成されたレポートの例。
• プログラムの特定の機能に関する拡張リファレンス。

これら 2 つの HTML ファイルは、Sphinx ではなく、プログラム自体によって生成されます。

Read the Docsで自分のドキュメントをホストしたいのですが、Sphinx ドキュメントと一緒にバージョン管理された 2 つのカスタム ページを構築してホストすると非常に便利です。

[プロジェクトのインストール] オプションが有効になっているため、プログラムは既に RtD ビルド環境にインストールされています。また、RtD のドキュメントでは独自の builder の作成について言及されているため、そこからプログラムを呼び出して、特定の場所に HTML コンテンツをダンプさせることができる可能性があると考えています。

だから私は本当に2つの質問があります:

1. これは Read the Docs の適切な使い方ですか? 任意の Web ページをホストするようには設計されていないと思いますが、これらのファイルは任意ではなく、ドキュメントの重要な部分です。

2. どうすれば実装できますか？RtD APIの意味を理解するのに苦労しています。この「ビルダー」はSphinx ビルダーに関連していますか? RtD に接続するにはどうすればよいですか? おそらくどこかに例がありますか？

このリンクの指示から、python3仮想環境のローカルシステム（Ubuntu 14.04）にreadthedocsをインストールしようとしています

pip3 install -r requirements.txtを実行すると、 Distutils2 のエラーが発生しました。distutils2 はサポートされなくなり、setuptools で十分であると想定したため、その依存関係を削除しました。

このコマンド python manage.py migrate を実行すると、以下のエラーが発生しました:

上記のスタックトレースから、コードが python2 にあるため、 print ステートメントが python3 で異なることがわかりました。

これは、 readthedocs を python2 virtualenv にインストールする必要があるということですか?

readthedocs 社内サーバーで python3 プロジェクトのドキュメントをホストすることはできませんか?

私はsphinxとRSTを使用して技術ドキュメントを HTML として生成していますが、ローカルの PDF 参照をハイパーリンクとして機能させるのに問題があります。ローカル PDF へのリンクを使用している人を見てきましたが、参照用にディレクトリ:download:内に PDF を埋め込んでいます。ブラウザーにインラインで PDF が表示されないため、ユーザーが消費するために追加の手順が必要になるため、/docs私は好きではありません。:download:

sphinx-build -b htmlconfig.pyhookhtml_static_pathまたはhtml_extra_path- で指定されていない限りファイルをコピーせず、その場合でもrootディレクトリまたは_staticフォルダーにドロップされます。

リンクされたバイナリ ファイルを sphinx 内に埋め込むための推奨される方法はありますか、それとも不適切な方法ですか? 多くの場合、リンクは、他のどこにもホストされていないスライド デッキまたは設計図へのリンクです。

リンクされた PDF のサンプル RST

ReadTheDocs によってレンダリングされ、ホストされているドキュメントがあります。「最終更新日」行の代わりに Git コミット ハッシュが引き続き表示されますが、ローカルの HTML ドキュメントには今日の日付が表示されます。

ローカル バージョン:

オンライン版:

docs/conf.pyファイルでは、非値 -> 空文字列に設定しhtml_last_updated_fmtましたNone。
ソース: https://github.com/VLSI-EDA/PoC/blob/master/docs/conf.py#L173-L176

ReadTheDocs が私の設定を無視するのはなぜですか? 最終更新日を取得するにはどうすればよいですか?

私は個人的な「ハウツー」ガイドに取り組んでおり、私の研究を記録し、日記をつけています。

私は今、ほとんど長すぎるコードブロックを持っています.この長さのコードに遭遇したとき、ページ全体を強調表示せずにブロックだけを強調表示しようとするか、十分ではありません.

それで、私の質問は、rst(reStructuredText)の場合、自動ハイライトまたはテキストをユーザーのクリップボードに自動的に追加する.. code-block::ためのアドオンまたはボタンに追加する方法はありますか? copyそれとも、これは、ビルドに含めてコード ブロックで参照する必要がある、より html-literal なタイプのコードでしょうか? もしそうなら、そのようなものはどのように見えるでしょうか?

私はsphinx-autodoc-annotationを使用して Python コードの関数注釈を読み取り、それを使用して適切な予想される引数の型と戻り値の型を生成しています。私のローカルマシンではうまく機能していますがpip install sphinx-autodoc-annotation、もちろんそうしなければなりませんでした。

Read the Docsを使用して同じドキュメントを生成しようとしていますが、エラーが発生します。

Read the Docs を sphinx-autodoc-annotation で動作するように構成することはできますか? もしそうなら、どのように動作させるのですか?

ReadTheDocs をインポートしてビルドするプロジェクトを 1 年近く行っています。しばらく更新がなかったので、ドキュメントを再構築する時が来たと判断しました。ただし、ビルドは次のようなあまり有益ではないエラーで失敗するようになりました。

エラー: プロジェクトのインポートに失敗しました: ' https://subversion.xray.aps.anl.gov/pyGSAS/trunk/ ' (svn チェックアウト) からコードを取得できませんでした: 1

「ワイプ」オプションを見つけて、それが役立つかどうかを確認しようとしましたが、それもうまくいきませんでした.

私たちのリポジトリに関連する何かが問題であると信じていますが (アクセスできない人から聞いたことはありませんが)、そのケージのバーをガタガタ鳴らし始める前に、より具体的で明確な何かが必要です.

提案は大歓迎です！

Win10 に Read the Docs のローカル インスタンスをインストールしようとしています

このドキュメントに従うと:
http://docs.readthedocs.io/en/latest/install.html

次のように入力します。

次のエラーが表示されます。

誰でもこのエラーを知っていますか？

私のピップバージョン: 8.1.2;
パイソン: 3.5