タグ

sphinxに関するMukeのブックマーク (4)

  • (23日目) blockdiag の便利な使い方(サンプル集) - 2011-12-23 - Hack like a rolling stone

    いま現在、blockdiag.com には使い方の例は書いてありますが、 どんな図が書けるのかというサンプルがほとんどありません。 これは単に僕の努力不足なのですが、たまには書きこまれた図をお見せしてみたいと思います。 画面遷移図 最初にご紹介するのは画面遷移図です。 もともと blockdiag を作り始めるきっかけは画面遷移図を書くことだったので、 blockdiag と画面遷移図は非常に相性がいいです。 どの画面からどの画面に遷移するのかを矢印(->)で書くだけで図が出来上がります。 ちょっとしたマスタ管理であれば、遷移だけを書いていけば図が出来上がります。 もちろん、途中で画面を追加したくなっても、画面が廃止になっても定義を書き換えるだけです。 blockdiag { トップページ -> メニューA, メニューB, メニューC; メニューA -> ○○一覧 -> ○○追加, ○○編

    (23日目) blockdiag の便利な使い方(サンプル集) - 2011-12-23 - Hack like a rolling stone
  • Pythonをやるときに参考になりそうな情報 - のんびりSEの議事録

    最近あんまり触っていなかったので、久々にPythonをやろうと思ったときにいろいろ忘れてたり、新しく知ったりしたこともあったので、Pythonやるときに参考になりそうな情報をまとめました (但し、今回はデータ分析系のライブラリ関連は除いています) Pythonの言語仕様や基等 概要 — Python 3.5.2 ドキュメントdocs.python.jp qiita.com www.python-izm.com 2系と3系の違い postd.cc qiita.com コーディング規約 はじめに — pep8-ja 1.0 ドキュメント ドキュメント生成 azunobu.hatenablog.com ドックストリング """ 3重ダブルクォートを使用して記載する。 ドックストリングに記述したテキストは関数やクラスオブジェクトの__doc__に保存される def hello(): """Out

    Pythonをやるときに参考になりそうな情報 - のんびりSEの議事録
  • Sphinxでドキュメントを書くためreST記法に入門した - kk_Atakaの日記

    あらすじ Sphinxを導入した時にまとめたreST(reStructuredText)記法をアウトプットしよう。まだリファレンス読み込んでおらず、感覚で使っているところもあるので間違った認識もあるかも…そこは学んだら追記しよう。 参考 Overview — Sphinx v1.0 (hg) documentation reStructuredText 基的にSphinxのサイトに書いてあることを写経してます。 注意 見出しの文字数より少なくならないように上下囲む、とかテーブルは列・行を合わせるとか結構シビアな書き方が求められるのですが……pre記法にしても揃ってない…! 見出し系 間違って覚えていたので、見出し系についてはSphinxの見出しについて学びなおし - kk_Atakaの日記を参照。 h1見出し 半角イコールで上下を揃えて囲むとh1と同等。 ================

  • reStructuredText入門 — Sphinx v1.0 (hg) documentation

    reStructuredText入門¶ このセクションは、reStructuredText(reST)の考え方や文法についての短いイントロダクションです。Sphinxユーザがドキュメントを作成するために十分な情報を提供します。reSTはシンプルに設計された、控えめなマークアップ言語ですので、理解するのにそれほど時間はかからないでしょう。 段落(パラグラフ)¶ 段落はreSTドキュメントにおける、もっとも基的な要素です。段落は1行以上の空行で区切られた、シンプルなテキストの固まりです。 Pythonにおいてインデントが重要な意味を持つのと同様、reSTでもインデントは重要です。同じ段落のすべての行は、インデントを同じ高さにそろえて、左揃えにしなければなりません。 インラインマークアップ¶ 標準のreSTインラインマークアップは極めてシンプルです。 アスタリスク1つ: *テキスト* 強調(

  • 1