問題タブ [read-the-docs]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
6 に答える
8401 参照

python-sphinx - クリック可能な SVG 画像を Sphinx ドキュメントに挿入する

それぞれがURLに関連付けられている複数のノードを持つSVG画像ファイルがあります。このファイルをブラウザで直接開くと、各ノードをクリックすると別の URL が開きます。ただし、Sphinx のドキュメントでこの画像を使用すると機能しません。全体としてレンダリングされた画像なので、それを開いてからView Imageノードをクリックする必要があります。

私は標準の画像ディレクティブを使用しています:

おそらく私は何か他のものを使う必要がありますか?

0 投票する
1 に答える
1198 参照

read-the-docs - readthedocs に最新バージョンが表示されないのはなぜですか?

次のプロジェクトでは:

https://readthedocs.org/projects/django-guardian/versions/

バージョン 1.4.1 が表示されません。まだバージョン 1.4.1 が github でタグ付けされており、この変更後にプッシュを行いました。

https://github.com/django-guardian/django-guardian/releases

v1.4.1 を表示するにはどうすればよいですか? 管理バージョンのオプションにも表示されません。

(v1.4.0 も表示されませんが、これは手動でこのリビジョンを無効にしたためです。依存関係がないため、readthedocs がこのバージョンをビルドできないエラーが発生しました)

0 投票する
0 に答える
204 参照

python - readthedocs.org の sphinx-doc ドキュメントは、プライベート sphinxcontrib-package に依存します

私は、readthedocs.org で sphinx-doc の Web サイトをホストしています。これは、プライベート sphinx-doc extension/sphinxcontrib-package [extension_name] に依存しています。私のローカル PC では、この拡張機能はサブディレクトリ [sphinx-doc project root]/exts/sphinxcontrib-[extension name] にあり、conf.py で「参照」されいます。

.py ファイルは「ソース」ディレクトリsphinxcontribにあります。ローカルの sphinx-doc ビルド出力は期待どおりです。ただし、readthedocs.org のビルドは失敗します。

拡張機能はベータ段階にあるため、オンラインで配布したくありません。(私がそうするなら、私が推測する Web ソースから readthedocs.org プレビルドとしてインストールできるはずです。) この問題をどのように処理できますか?

0 投票する
1 に答える
194 参照

python - ドキュメントを読む ビルドに失敗しました UnicodeDecodeError

私はhttps://readthedocs.orgにいます.python3で書かれたプロジェクトドキュメントを構築しようとしています.

設定:

ドキュメントタイプ: Sphinx html

プログラミング言語: パイソン

仮想環境を使用する

Python インタープリター: CPython 3.x

次の時点で失敗しました:

と:

詳細はhttps://readthedocs.org/projects/crawler/builds/3711852を参照

0 投票する
2 に答える
757 参照

python-sphinx - Sphinx ReadTheDocs テーマのトップ ナビゲーション バー (ブレッドクラム) を無効にする

ReadTheDocs テーマのトップ ナビゲーション バーを無効にしたいと考えています。他のテーマの場合、たとえば、classicそれは単なるオプションです

ドキュメントを読むテーマを変更して、このトップ ナビゲーション バーを無効にするにはどうすればよいですか?

編集: でソース ファイルを処理した後make html、html ファイルでこれらの行を削除する必要があります。

期待される結果を得るために。でソースをコンパイルする前にこの結果を取得することは可能make htmlですか?

0 投票する
1 に答える
56 参照

read-the-docs - 壊れたドキュメントを読んでください。直し方?

http://django-guardian.readthedocs.org/en/latest/installation.htmlにアクセスすると、スタイリングなしの生のコンテンツが表示されます。CSS ファイルは正常にロードされているように見えますが、影響はありません。ローカル ボックスでドキュメントを手動で作成すると、正常に動作します。

0 投票する
2 に答える
378 参照

python - Readthedocs の Sphinx エラー:「TypeError: 'bool' オブジェクトに属性 '__getitem__' がありません」

Readthedocs のドキュメントのビルドは、非常に理解しにくい Sphinx エラーで失敗しました。

完全なログについては、https://readthedocs.org/projects/fluidimage/builds/3758665/を参照してください。

他のプロジェクトでも同じような問題が発生していることがわかりました ( Google 検索へのリンク)。

このエラーはどういう意味ですか? どうすれば解決できますか?

0 投票する
1 に答える
538 参照

python - sphinx - 1 つの章に複数のファイルがあり、rtd テーマを使用したクリーンな html ナビゲーションは可能ですか?

私はドキュメントを書くために sphinx 1.3.4¹ をmake html使用しており、「ドキュメントを読む」テーマ² を使用しています。

このドキュメントの index.rst に、Lv 1 から Lv3 までの見出しを持つファイル chaper1.rst を含めると、結果のナビゲーション サイドバーに lv 1 という見出しが表示されます。この見出しをクリックすると、折りたたまれて見出し lv2 -lv3 が表示されます。大丈夫です。

chapter1 をいくつかのファイルに分割すると、index.rst で使用できchaper1/*、結果の html ドキュメントにすべてのファイルが含まれます。しかし、各ファイルの見出し (最初のlv2のファイルも含む) は、中央のナビゲーション サイドバーの折りたたみで個別の章として表示されます。章の見出しが折りたたまれることはもうありません。:-/

章ごとに複数のファイルを使用して、左側にきれいなナビゲーションを作成するにはどうすればよいですか?

ティア!

編集 rtd-theme バージョン 0.1.9 のバックポートを行いました - 変更はありません。ということで、スフィンクスの問題のようです。複数のファイルを 1 つの章に適切に含めるにはどうすればよいですか?

[1] https://packages.debian.org/jessie-backports/python3-sphinx
[2] https://packages.debian.org/jessie/python3-sphinx-rtd-theme

0 投票する
1 に答える
121 参照

python-sphinx - 目次の適切な場所にマイナー ページを配置する

私のスフィンクスのドキュメントには、(もちろん) toctree の一部にする必要があるいくつかのマイナーなページがありますが、それらを適切な場所にリストすることができません。

「セクション 3」ページが次のようになっている場合:

次に3.3とが の前に3.4リストされます。 3

他の順列を試しましたが、どれもうまくいかないようです。

  1. 3見出しの後に toctree を配置すると、3.3の間3.4リストされます。 33.1
  2. ページの最後に toctree を配置すると、すべてが正しい順序になりますが3.33.4section の子である第 3 レベルのセクションになります3.2

ここに具体的な例を挙げました:

0 投票する
3 に答える
1595 参照

setuptools - readthedocs と setuptools scm のバージョンが間違っています

setuptools_scm を使用するように更新したばかりのパッケージがあり、readthedocs でバージョン番号が間違っていることがわかりました。

http://sshuttle.readthedocs.org/en/v0.77/ショー:

ただし、バージョン 083293e には 0.77 タグがあるため、バージョン文字列は 0.77 にする必要があります。

ビルド前に readthedocs がソース コードを変更しているようです。

readthedocs ビルド ログを調べたところ、ある段階 (0.77) では正しいバージョンのようですが、これはドキュメントをビルドする前です。

ドキュメントのビルド中、ビルド ログにはバージョンが記載されていません。

これを解決することは可能ですか?

ありがとう