タグ

documentationとreStructuredTextに関するdrumscoのブックマーク (5)

  • 概要 — Sphinx 1.4.4 ドキュメント

    A project Download 現在のバージョン: 1.4.4 Python Package Indexからソースコードをダウロードするか、以下のコマンドでインストールしてください: pip install -U Sphinx 疑問? 意見? Googleグループのsphinx-users グループへの参加 もしくは、FreeNodeの#sphinx-docチャンネルへどうぞ。 何か気づいたことがあれば、issue trackerを使用して報告することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。Pythonプロジェクトのためのすばらしい機能を提供してきましたが、現在ではC/

  • Pandoc - index

    If you need to convert files from one markup format into another, pandoc is your swiss-army knife. Pandoc can convert between the following formats: (← = conversion from; → = conversion to; ↔︎ = conversion from and to) Lightweight markup formats ↔︎ Markdown (including CommonMark and GitHub-flavored Markdown) ↔︎ reStructuredText → AsciiDoc ↔︎ Emacs Org-Mode ↔︎ Emacs Muse ↔︎ Textile → Markua ← txt2t

  • reStructuredText Markup Specification日本語訳: misc. -KtJ Dragon

    reStructuredText Markup Specification日語訳 公開日: 2008/11/24 更新日: 2020/07/12 reStructuredTextは文書の構造を記述するための、シンプルかつ直感的な構成のプレーンテキストである。これらの構成は、加工前、加工後のいずれの形態でも等しく容易に読むことができる。この文書はそれ自身がreStructuredTextの一例である(あなたがテキストファイルを直接読んでいるならばそれはパーサによって処理されてないものである。また、例えばHTML文書を読んでいるならばそれは処理された後のものである)。reStructuredTextのパーサは、Docutilsの構成要素である。 特別な構成、例えばセクション見出し、ブレットリスト、強調表現を示すためにシンプルかつ暗黙のマークアップが使用される。使用されるマークアップは、最小か

  • ReStructuredText 入門

    以下の文章中に "(quickref)" という形式のリンクがあります。これは、 Quick reStructuredText ユーザリファレンスへの相対リンクです。このリンクが 切れている場合は、 オンラインのクイックリファレンス を参照してください。 構造 まずはじめに、"Structured Text" (構造化されたテキスト)という呼び方には、 いくぶん不適切なところがあると指摘しておきます。実際には、首尾一貫したパターンを使う "Relaxed Text" (形式ばらないテキスト)とでも呼ぶべきものです。そのパターンを HTML コンバータで変換することで、WEB ブラウザで扱えるような「非常に構造化された テキスト」が生成されるのです。 最も分かり易くて基的なパターンは、 パラグラフ(段落) (quickref) です。 (1つ以上の)空行で区分されたテキストのひとかたまりが

  • はやわかり reStructuredText

    マークアップ記法の完全な詳細は reStructuredText のページに示されています。このテキストは、覚書としての性格の文書です。 "(詳細)" というリンクを辿ると reStructuredText 仕様書を参照できます。 ただし、相対リンクとなっていますので、リンク切れの場合は、 原版の "Quick reStructuredText" から参照してください。 目次 インライン マークアップ バックスラッシュによるエスケープ 章立ての構造 段落 記号つきリスト 番号つきリスト 定義リスト フィールドリスト オプションリスト 整形済みブロック ラインブロック 引用 Doctestブロック 表 区切り線 明示的マークアップ 脚注 出典 リンクターゲット 外部ターゲット 内部ターゲット 間接ターゲット 暗黙ターゲット ディレクティブ 代入参照とその定義 コメント 助けを得たい場合は

  • 1