rst-buildhtml - クラウドでオンライン

プログラム：

NAME

rst-buildhtml - 多くの reST ドキュメントを HTML に変換します

SYNOPSIS

rst-buildhtml [オプション] [ ...]

DESCRIPTION

それぞれのすべての reStructuredText .txt ファイル (PEP を含む) から .html を生成します。
(デフォルトは現在のディレクトリです)。

OPTIONS

全般 ドクチル オプション
--title =TITLE
ドキュメントのタイトルをメタデータとして指定します。

- 発生器, -g
「GeneratedbyDocutils」のクレジットとリンクを含めます。

-ジェネレータなし
発電機クレジットを含めないでください。

- 日にち, -d
ドキュメント（UTC）の最後に日付を含めます。

- 時間, -t
日時（UTC）を含めます。

--日付スタンプなし
いかなる種類の日付スタンプも含めないでください。

-ソースリンク, -s
「ドキュメントソースの表示」リンクを含めます。

--source-url =
使用するソースリンクの場合。 --source-linkを意味します。

--ソースリンクなし
「ドキュメントソースの表示」リンクを含めないでください。

--toc-entry-バックリンク
セクションヘッダーから目次エントリへのリンク。 （ディフォルト）

--toc-top-バックリンク
セクションヘッダーから目次の上部にリンクします。

--no-toc-バックリンク
目次へのバックリンクを無効にします。

-脚注-被リンク
脚注/引用から参考文献へのリンク。 （ディフォルト）

-脚注なし-被リンク
脚注や引用からの被リンクを無効にします。

-セクション番号
Docutilsによるセクション番号付けを有効にします。 （ディフォルト）

--セクション番号なし
Docutilsによるセクション番号付けを無効にします。

--strip-コメント
ドキュメントツリーからコメント要素を削除します。

--コメントを残す
ドキュメントツリーにコメント要素を残します。 （ディフォルト）

--strip-elements-with-class =
classes = "ですべての要素を削除します"ドキュメントツリーから。警告：
潜在的に危険です。 注意して使用してください。 （多目的オプション。）

--strip-class =
すべてのクラスを削除= " "ドキュメントツリーの要素からの属性。
警告：潜在的に危険です。 注意して使用してください。 （多目的オプション。）

-レポート=, -r
以上のシステムメッセージを報告する：「情報」または「1」、「警告」/「2」
（デフォルト）、「エラー」/「3」、「重大」/「4」、「なし」/「5」

-詳細, -v
すべてのシステムメッセージを報告します。 （「-report = 1」と同じです。）

- 静かな, -q
システムメッセージを報告しない。 （「-report = 5」と同じです。）

--halt =
以上のシステムメッセージで実行を停止する。 --reportのようなレベル。
デフォルト：4（重大）。

- 厳しい
少しでも問題が発生したときに停止します。 「--halt = info」と同じです。

-終了ステータス=
停止しないシステムメッセージのゼロ以外の終了ステータスを有効にする。
デフォルト：5（無効）。

- デバッグ
デバッグレベルのシステムメッセージと診断を有効にします。

--デバッグなし
デバッグ出力を無効にします。 （ディフォルト）

-警告=
システムメッセージの出力をに送信します。

-トレースバック
Docutilsが停止しているときにPythonトレースバックを有効にします。

-- トレースバックなし
Pythonトレースバックを無効にします。 （ディフォルト）

--input-encoding =, -i
入力テキストのエンコーディングとオプションでエラーハンドラを指定します。 ディフォルト：
：厳しい。

--input-encoding-error-handler =INPUT_ENCODING_ERROR_HANDLER
デコードできない文字のエラーハンドラーを指定します。 選択肢：「厳密」（デフォルト）、
「無視」、「交換」。

--output-encoding =, -o
テキストエンコーディングを指定し、オプションで出力用のエラーハンドラを指定します。 ディフォルト：
UTF-8：厳密。

--output-encoding-error-handler =OUTPUT_ENCODING_ERROR_HANDLER
暗号化できない出力文字のエラーハンドラーを指定します。 「厳密」（デフォルト）、
「ignore」、「replace」、「xmlcharrefreplace」、「backslashreplace」。

--error-encoding =, -e
エラー出力用のテキストエンコーディングとエラーハンドラを指定します。 ディフォルト：
ascii：backslashreplace。

--error-encoding-error-handler =ERROR_ENCODING_ERROR_HANDLER
エラー出力で暗号化できない文字のエラーハンドラを指定します。 ディフォルト：
バックスラッシュ置換。

-言語=, -l
言語を指定します（BCP 47言語タグとして）。 デフォルト：en。

--record-dependencies =
出力ファイルの依存関係を。

--config =
から構成設定を読み取ります、存在する場合。

- バージョン, -V
このプログラムのバージョン番号を表示して終了します。

- 助けて, -h
このヘルプメッセージを表示して終了します。

PEP リーダー オプション デフォルト
--pep-references および --rfc-references オプション (reStructuredText パーサー用) がオンになっています
デフォルトでは

reStructuredText パーサ オプション
--pep-references
スタンドアロンのPEP参照（「PEP258」など）を認識してリンクします。

--pep-base-url =
PEP参照のベースURL（デフォルトは "http://www.python.org/dev/peps/"）。

--pep-file-url-template =
URLのPEPファイル部分のテンプレート。 （デフォルトは「pep-％04d」）

--rfc リファレンス
スタンドアロンのRFC参照（「RFC822」など）を認識してリンクします。

--rfc-base-url =
RFC参照のベースURL（デフォルトは "http://www.faqs.org/rfcs/"）。

--tab-width =
タブ拡張用のスペースの数を設定します（デフォルトは8）。

--trim-脚注-参照スペース
脚注参照の前のスペースを削除します。

--脚注参照スペースを残す
脚注参照の前にスペースを残します。

--ファイル挿入なし
外部ファイルの内容を挿入するディレクティブを無効にします（ "include"＆ "raw"）;
「警告」システムメッセージに置き換えられました。

--ファイル挿入が有効
外部ファイルの内容（「include」および「raw」）を挿入するディレクティブを有効にします。
デフォルトで有効になっています。

--未加工
「生の」ディレクティブを無効にします。 「警告」システムメッセージに置き換えられました。

--raw 対応
「raw」ディレクティブを有効にします。 デフォルトで有効になっています。

--syntax-highlight =
Pygmentsを使用してコードを解析するために設定されたトークン名：「long」、「short」、または「none（no
解析）」。デフォルトは「long」です。

--smart-quotes =SMART_QUOTES
まっすぐな引用符を活版印刷の形式に変更します：「はい」、「いいえ」、
"alt [ernative]"（デフォルトは "no"）。

HTML 固有 オプション
--template =
テンプレートファイル（UTF-8エンコード）を指定します。 デフォルトは
"/usr/share/docutils/writers/html4css1/template.txt".

--stylesheet =
スタイルシート URL のカンマ区切りリスト。 以前の --stylesheet をオーバーライドし、
--stylesheet-path の設定。

--スタイルシートパス=
スタイルシート パスのカンマ区切りリスト。 一致する場合、相対パスは展開されます。
ファイルは --stylesheet-dirs にあります。 --link-stylesheet を使用すると、パスは次のようになります。
出力 HTML ファイルを基準にして書き換えられます。 デフォルト: 「html4css1.css」

--埋め込みスタイルシート
出力 HTML ファイルにスタイルシートを埋め込みます。 スタイルシート ファイルは次のとおりである必要があります。
処理中にアクセスできます。 これがデフォルトです。

--リンクスタイルシート
出力 HTML ファイル内のスタイルシートへのリンク。 デフォルト: スタイルシートを埋め込みます。

--stylesheet-dirs=
スタイルシートが見つかるディレクトリのカンマ区切りのリスト。 によって使われた
相対パス引数を展開する場合は --stylesheet-path。 デフォルト： "['。'、
'docutils/writers/html4css1']"

--initial-header-level=
初期ヘッダーレベルを指定します。 デフォルトは 1 です。 "。影響しません
ドキュメントのタイトルとサブタイトル (--no-doc-title を参照)。

--フィールド名制限=
XNUMX 列のフィールド名の最大幅 (文字数) を指定します。 より長いです
フィールド名は、フィールド リストのレンダリングに使用されるテーブルの行全体に及びます。
デフォルトは 14 文字です。 「制限なし」には 0 を使用します。

--オプション制限=
オプション リストのオプションの最大幅 (文字数) を指定します。 より長いです
オプションは、オプション リストのレンダリングに使用されるテーブルの行全体にまたがります。
デフォルトは 14 文字です。 「制限なし」には 0 を使用します。

--脚注参照=
脚注参照の形式: 「上付き文字」または「括弧」のいずれか。 デフォルトは
「ブラケット」。

--属性=
ブロック引用の属性の形式: 「ダッシュ」(em-dash プレフィックス) のいずれか
「括弧」/「括弧」、または「なし」。 デフォルトは「ダッシュ」です。

--compact-lists
「単純な」箇条書きリストの項目間の余分な垂直空白を削除し、
列挙されたリスト。 デフォルト: 有効。

--no-compact-lists
コンパクトな単純な箇条書きリストと列挙リストを無効にします。

--compact-field-lists
単純なフィールド リストの項目間の余分な垂直空白を削除します。 デフォルト：
有効になりました。

--no-compact-field-lists
コンパクトなシンプルフィールドリストを無効にします。

--テーブルスタイル=TABLE_STYLE
標準テーブルクラスに追加されました。 定義されたスタイル: 「ボーダーレス」。 デフォルト： ""

--数学出力=MATH_OUTPUT
数学出力形式。「MathML」、「HTML」、「MathJax」、または「LaTeX」のいずれか。 デフォルト: 「HTML
math.css"

--no-xml-宣言
XML宣言を省略します。 注意して使用してください。

--cloak-メールアドレス
電子メールのリンクを保持したまま、電子メール アドレスを難読化してハーベスターを混乱させる
標準に準拠したブラウザで使用できます。

PEP/HTML 固有 オプション
PEP/HTML ライターの場合、 --stylesheet-path オプションのデフォルト値は次のとおりです。
"/usr/share/docutils/writers/pep_html/pep.css"、 --template のデフォルト値は次のとおりです。
"/usr/share/docutils/writers/pep_html/template.txt上記の HTML 固有のオプションを参照してください。

--python-home=
Python のホーム URL。 デフォルトは「http://www.python.org".

--pep-home=
PEP のホーム URL プレフィックス。 デフォルトは「.」です。 （カレントディレクトリ）。

ビルド-HTML オプション
-再帰
処理するファイルのサブディレクトリを再帰的にスキャンします。 これがデフォルトです。

- ローカル
処理するファイルのサブディレクトリをスキャンしないでください。

--プルーン=
内のファイルを処理しないでください(シェルのグロブパターン、コロンで区切られています)。
このオプションは複数のディレクトリを指定するために複数回使用できます。 デフォルト：
「.hg:.bzr:.git:.svn:CVS」。

--ignore =
指定されたワイルドカードのいずれかに一致するファイルを再帰的に無視します (シェル グロビング)
パターン (コロンで区切られます)。

- 静けさ
サイレントに作業します (進捗メッセージは表示されません)。 「--静か」から独立しています。

-ドライラン
ファイルを処理せず、処理されるファイルを表示します。

RST-BUILDHTML(1)

onworks.net サービスを使用してオンラインで rst-buildhtml を使用する