原稿を追加
Markdownを貼り付けるか、.mdファイルを開きます。
Markdownの文書構造を、PythonやSphinxのドキュメントで使われるreStructuredTextへ変換します。変換後の.rstは編集して仕上げられます。
プロジェクトノート
=========
読みやすい文書は、**分かりやすい構造**から始まります。
確認すること
------
* 見出しの階層
* 正しく開くリンク
* 再利用しやすいファイル
ダウンロード前にプレビューを確認します。
見出しの下線幅やディレクティブは、最終ビルド環境でも確認します。
Markdownを貼り付けるか、.mdファイルを開きます。
見出し、リンク、リスト、コードブロックの記法を確認します。
.rstをダウンロードし、Sphinxなど目的の処理系で警告を確認します。
一般的な要素を、reStructuredTextで読めるソースに置き換えます。
READMEや既存ガイドをPythonプロジェクトのドキュメントへ取り込みます。
Markdownで用意した内容をRST指定の公開環境へ合わせます。
複数記法で残った手順書をRSTベースへ集約する下準備にします。
Markdownに対応情報がない場合、toctreeやautodocなどのディレクティブは自動生成しません。
まずSphinxなどでビルドし、見出し、リンク、表の警告を確認してください。
RSTに直接対応しないHTMLは、内容の簡略化やrawディレクティブへの手直しが必要です。