4. Sphinxでの文章の書き方(reStructuredText)¶ ここでは、自分がよく使う書き方を集めてみました。 4.1. セクション¶ セクション名となる文字列の下に、-や=で線を引きます。これでセクションを作ることができます。 セクションは全部で６レベル分作ることができ、出現した順番にレベル分けされます。 セクション名に使用できる記号はたくさんありますが、見やすさから:
4. Sphinxでの文章の書き方(reStructuredText) — study sphinx 1 documentation
4. Sphinxでの文章の書き方(reStructuredText)¶ ここでは、自分がよく使う書き方を集めてみました。 4.1. セクション¶ セクション名となる文字列の下に、-や=で線を引きます。これでセクションを作ることができます。 セクションは全部で６レベル分作ることができ、出現した順番にレベル分けされます。 セクション名に使用できる記号はたくさんありますが、見やすさから:
Sphinxを使って自分用技術メモをAtom / VSCodeで取る時にやっていることの紹介 - Qiita
発表資料 これは#ssmjp 2016/07の発表資料用の記事です 何故この話をするか？ A. この組み合わせの情報をあまり見かけないから Sphinx Atom VSCode 伝えたいこと 「実際にこうやっている」という例の提示 深い話はしない SphinxとAtom / VSCodeを組み合わせて使う時のちょっとしたコツについて話す。 個別の技術の深い話は各種書籍や公式ドキュメントに委譲。 『Sphinxをはじめよう』 『Atom実践入門』 注意事項 過剰なエディタ宗教戦争論議はする予定なし 個人的な見解多め 2016年7月現在の情報 陳腐化する箇所もある 特にエディタとそのプラグイン関連 自己紹介 清水 琢(@takuan_osho) Sphinxとの関わりは2011年2月のSphinx翻訳ハッカソンから 今までで一番大きなSphinxへの貢献はepub3ビルダーのプルリクエスト 1
ReStructuredText 入門
以下の文章中に "(quickref)" という形式のリンクがあります。これは、 Quick reStructuredText ユーザリファレンスへの相対リンクです。このリンクが 切れている場合は、 オンラインのクイックリファレンス を参照してください。 構造 まずはじめに、"Structured Text" （構造化されたテキスト）という呼び方には、 いくぶん不適切なところがあると指摘しておきます。実際には、首尾一貫したパターンを使う "Relaxed Text" （形式ばらないテキスト）とでも呼ぶべきものです。そのパターンを HTML コンバータで変換することで、WEB ブラウザで扱えるような「非常に構造化された テキスト」が生成されるのです。 最も分かり易くて基本的なパターンは、 パラグラフ（段落） (quickref) です。 （1つ以上の）空行で区分されたテキストのひとかたまりが
はやわかり reStructuredText
本マークアップ記法の完全な詳細は reStructuredText のページに示されています。このテキストは、覚書としての性格の文書です。 "(詳細)" というリンクを辿ると reStructuredText 仕様書を参照できます。 ただし、相対リンクとなっていますので、リンク切れの場合は、 原版の "Quick reStructuredText" から参照してください。 目次 インライン マークアップ バックスラッシュによるエスケープ 章立ての構造 段落 記号つきリスト 番号つきリスト 定義リスト フィールドリスト オプションリスト 整形済みブロック ラインブロック 引用 Doctestブロック 表 区切り線 明示的マークアップ 脚注 出典 リンクターゲット 外部ターゲット 内部ターゲット 間接ターゲット 暗黙ターゲット ディレクティブ 代入参照とその定義 コメント 助けを得たい場合は
【追記あり】SphinxのblockdiagでOSごとにフォント設定を変える方法
Sphinxで簡単なフローとかを書く時にblockdiagを使うことがある。ただ、blockdiagは、フォント設定をしておかないとSphinxのビルド時にエラーになってしまう。 しかも、フォントの設定はMac・Linux・Windowsでパスも使うフォントも違う。そこで、Sphinxのconf.pyを使って、OSごとにフォント設定を変える方法を紹介。 追記 この記事を公開後、Twitterで作者さんからもっと便利な対処方法を教えていただきました。そちらの方が便利なので、以下の方法をお勧めします。@tk0miyaさんありがとうございました！ blockdiag_fontpath = [ 'C:\WINDOWS\Fonts\MEIRYO.TTC', '/Users/mas/Library/Fonts/meiryo.ttc', '/etc/alternatives/fonts-japanese
Sphinx 文書に markdown フォーマットを利用する - Hack like a rolling stone
この記事は Sphinx アドベントカレンダーの 19日目です。 markdown と Sphinx (reST) Sphinx では文書を書く際の記述フォーマットに reStructured Text を利用していますが、 世を広く見回すと、github 然り、bitbucket 然り、様々な場所で markdown フォーマットが利用されています。 markdown フォーマットは reST と比べると表現力が低い上、表現を拡張することができないという点が指摘されています。 表現を拡張することができないため、いくつかの方言が存在するという問題もあります。 ですが、reST と比べてシンプルで、なおかつポピュラーに利用されているフォーマットであるため、 新しく Sphinx に触り始める人の取っ掛かりとしては、markdown はうってつけのフォーマットと言えます。 sphinxcont
MarkdownでSphinxできるようになったので試してみた（後編） - 意識の高いLISPマシン
この記事はドキュメンテーションツールAdvent Calendar (http://www.adventar.org/calendars/1196) の2日目です。 （まだまだ空欄だらけなので、執筆者も募集しています。） この記事は2部構成の2部目です。 1日目：概要の説明 MarkdownでSphinxできるようになったので試してみた（前編） - 意識の高いLISPマシン 2日目：実際に試してみた記録（いまここ） 今回は、実際にSphinxをインストールし、Markdownで文書が作成できるかどうかを試してみます。 なお、元ネタはこのプレゼンです（再掲）。 準備 Mac OS X上で作業。HomebrewでインストールしたPython2を使用します。 最近ターミナルをほったらかしていたので、まずHomebrewを整備します。 $ brew doctor $ brew update $ b
Sphinxの魔法にかかってみた - ふぞろいのGENGOたち
はじめに 最近ドキュメントの整備が最優先重要課題になってきたので、ドキュメントを効率よく書くための方法を調査していました。 年初くらいから調査していて、 「ドキュメントを作りたくなってしまう魔法のツール Sphinx」 とか 「遷移図生成ツール blockdiagの紹介]」 とか 「本当のドキュメントと向き合えますか」 を見て ようやく「Sphinxにしよう！」と決心したので、Windows環境にSphinxを導入してみました。 そこで、この記事ではWindows環境にSphinxを導入するための手順を紹介したいと思います。 記事の作成にあたって、次のサイトを参考にさせていただきました。 「blockdiag を WindowsXP で動かす」 「OmakeでSphinxを自動継続ビルドしてみよう」 目標 この記事では、次のことが実現できる環境を構築します。 Sphinxを使って、テキスト
自分用技術メモの作成が捗ったSphinxのあれこれについて - Qiita
はじめに この記事はHamee Advent Calendar 2016の17日目の記事です。 少し前から個人的にSphinx（Python製のドキュメンテーションツール）に触れていて、試しに自分用の技術メモの作成にSphinxを使ってみたら思った以上に捗ったので、その際に使った機能や拡張機能について書いていきます。 注意 この記事ではSphinxの詳細についてはほとんど紹介しません。 あくまでこんな機能・拡張機能を使ったら便利だったよ！といった ポエム 内容の記事となっていますので、あらかじめご了承ください。 TOCツリーのおかげで見通しが良く管理しやすい メモを1つのファイルに書いていくと、あれもこれもと書いているうちに次第に内容が膨大になっていき、後で振り返りをしようと思ったらメモが読みづらいとか内容を追加しようと思ったらどこに何が書いてあるかわかりづらい…なんてこともあるかと思いま
第1日目 Sphinx環境を構築しよう！ — Sphinx Advent Calendar 2012 (全部俺)
第1日目 Sphinx環境を構築しよう！ 初日は私が普段Windows上でどのようにSphinx環境を構築しているかをご紹介します。 Pythonのインストール SphinxはPythonの拡張モジュールなので、まずPythonのインストールが必要です。 下記ページよりインストーラーをダウンロードします。 Windows用インストーラ python-2.7.3.msi http://www.python.jp/Zope/download/pythoncore ノート Windowsの64bit(x64)版の場合も、上記のバージョンをダウンロードして下さい。 パッケージ管理ツール easy_install のインストール Pythonの拡張モジュール easy_installコマンド をインストールします。 下記をダウンロードします。 http://python-distribute.org
ドキュメントの継続的な開発方法 | IIJ Engineers Blog
私はソフトウェア開発を主体とするエンジニアで、 クラウドサービスの開発・運用 分散処理技術の検証とサービス利用の検討 社内の開発支援環境の開発・運用 などの業務に従事していますが、今回の記事は業務とは直接的な関係は無く、私が会社で勝手自発的に行っている取り組みについて書きたいと思います。 昨今、インターネットは生活に深く浸透し、クラウドサービスを利用することで安く簡単にWebサービスを開発、公開できるようになりました。Web技術の進化や流行の移り変りも非常に激しく、既存サービスの機能追加や新規サービスの開発は頻繁に行われています。それは弊社も例外ではありません。 このような開発の現場では、リーンソフトウェア開発への取り組みなど開発手法の最適化が積極的に行われ、様々なベストプラクティスが生みだされています。それらのベストプラクティスには、 継続的インテグレーション や 継続的デプロイメント
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
sphinxcontrib-markdown
https://github.com/takuan-osho/rst-cheatsheet/blob/japanese/rst-cheatsheet.rst
本家 Sphinx Advent Calendar 2012 10日目 ～サクラエディタから make html～ — Sphinx Advent Calendar 2012 (全部俺)
ドキュメントを作りたくなってしまう魔法のツールSphinx