問題タブ [restructuredtext]

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 投票する
1 に答える
1436 参照

documentation-generation - RestructuredTextとSphinxを使用して事前にフォーマットされたファイルを含める

私はこのフラグメントを機能させようとしています:

つまり、includeディレクティブを使用して、ファイルがブロック引用符として含まれるようにします。ブロック引用符の中に入ると、ディレクティブが引用符で囲まれます。ファイルの内容をブロック引用符で囲んでください。

これを行う方法はありますか?

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

python-sphinx - Sphinx: 相互参照インデックス付きアイテム

reStructuredText ドキュメント内のインデックス付きアイテムを相互参照するにはどうすればよいですか?

たとえば、セクション B を相互参照するにはどうすればよいですか。

次のような参照でインデックス ラベルを使用してみました。

しかし、これは機能しません。

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

restructuredtext - ReSTでより高いネストレベルに戻すにはどうすればよいですか?

再構成されたテキストで、どのように書くのですか?

0 投票する
5 に答える
16055 参照

restructuredtext - Sphinx と reStructuredText で数値を使用して図を参照する

Sphinxで処理される RST を記述しているときに、図を参照するときに Sphinx LaTeX 出力で図番号を使用することができません。たとえば、次のコード:

これに変換されます:

They're come!に見られるように、レミングが攻撃しています。

/ここに画像が入ります/

図 1.1: 彼らが来る!

しかし、私が欲しいのは、次のような図を参照する「標準的な」LaTeX の方法です。

図 1.1 に見られるように、レミングが攻撃しています。

どうすればこれを達成できますか? 私が現在使用しているコードは、Sphinx のマニュアルで推奨されているものですが、必要な出力が得られません。

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

restructuredtext - 再構築されたテキスト - 見出しをエスケープしますか?

reStructuredText ドキュメントがあります。rST は=====見出しの形式として などを使用します。

ただし、このテキストを含むいくつかの行を含める必要があります。

そして====、見出しとして解釈されたくありません。つまり、見出しになりたくありませんstuff。これらの等号がそのまま表示されるようにしたいと思います。

これはrSTで可能ですか?

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

restructuredtext - reStructuredTextツールのサポート

私はreStructuredTextの大ファンですが、それをサポートするツールはインターネット全体に散らばっています。公式ツールリストは不完全であるか古くなっており、コミット権限を介してのみ更新できます。しばらくの間、ウィキペディアのreStructuredTextページに包括的なリストがありましたが、これは明らかに「Webコンテンツの注目すべきガイドラインを満たしていない」ため削除されました。

質問形式にすると、テキストエディタ、ウィキソフトウェア、reStructuredTextとの間のコンバータなど、reStructuredTextを操作するときにどのようなツールサポートが見つかると期待できますか?

0 投票する
9 に答える
4673 参照

python - ReST ファイル用のインテリジェントなエディターはありますか?

私は Sphinx を学んでいて、ReST ファイルを編集する必要があります。そのためのインテリジェントなエディターはありますか? 同様に、コードの色付け、簡単なインデント、コード補完 (できれば) などを提供してくれるエディターです。

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

documentation - アドバイスが必要 - ローカリゼーションに重点を置いた柔軟なドキュメンテーション システムの開発

私はドキュメンテーション システム/プラットフォームの構築を担当しています。

主な要件の短いリストを次に示します。

  • ローカライズが容易: これには、すぐに十数か国語をサポートする必要があります。(非技術者が翻訳を追加/更新できることは大きな利点ですが、100% 必要というわけではありません)

  • 出力形式の柔軟性: 最低限、ドキュメントを (全体として、または選択したチャンクで) PDF および HTML として出力する必要があります。Windows ヘルプ ファイルなどのネイティブ フォーマットのボーナス ポイント。

  • 直感的なユーザー インターフェイス (理想的には Web) を介して管理および展開されます。

この種のことをすでにサポートしているシステムを知っているかどうか疑問に思っていますか? 私はこれをゼロから書くことを嫌いませんが、できることなら車輪の再発明はしたくありません。

これまでに私が遭遇した 2 つの主な候補は、DocBookreSTです。前者は、まあ、吸うという評判を得たようです. 私はどちらにもなじみがありませんが、reST を使えばかなりの部分を達成できると言われています。

他の提案はありますか?これをゼロから構築したほうがよいでしょうか?

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

python - Python の Web サイトはどのようにオンライン ドキュメントを生成していますか?

Sphinx 0.6.5 を使用して作成されました。

Python のドキュメントで が使用されていることは知っていますが、 や などreStructuredTextのセクションが異なります。http://docs.python.org/whatsnew/2.6.htmlhttp://docs.python.org/tutorial/index.html

reStructuredText でこれをどのように行いますか? rst2htmlその構造を維持しながら、多数のディレクトリで実行していますか?

Sphinx を使用していることは知っていますが ( Thomas Wouters の回答で直接 rst2html ではありません)、リポジトリ内のソース コード ファイルを使用して最初の構造をどのように整理すれば、本格的な自動化されたドキュメント Web サイトを作成できますか?

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

diff - rst2pdfを使用して最初の差分を視覚化する

rst2pdfを使用してrstファイル間の違いを視覚化する簡単な方法はありますか?代わりにrst2latexを使用してからlatexdiffを使用してPDFファイルを生成できることはわかっていますが(これが私が求めている効果です)、元のファイルとdiffファイルで同じスタイルを使用したいと思います。