Overview¶

Design¶

• 論文に何を書くべきか→これだけは埋めろ→論文作成穴埋めシート
• スケールする組織を支えるドキュメンテーションの技術を”GitLab Handbook”から学ぶ

pelican¶

CMS (Contents management system)¶

• Flat-File CMS
• https://www.catch.jp/wiki3/tools/flatfile_cms
• Bludit
• https://docs.bludit.com/en/getting-started/installation-guide
• {{collapse(Quick start)

$ sudo apt install -y php7.2-cli php7.2-gd php7.2-mbstring php7.2-json php7.2-xml
$ git clone https://github.com/bludit/bludit.git
$ cd bludit
$ php -S 0.0.0.0:8000

sphinx¶

pythonベースのドキュメント整形言語。とでも言えばいいのか。

• 公式
  • http://sphinx.pocoo.org/
  • http://sphinx-users.jp/

• 翻訳文書

  • http://sphinx.shibu.jp/

• Windowsで開始

  • http://sphinx-users.jp/gettingstarted/install_windows.html
    • 割と書いてある通り。Python 2.7.2でも順当に動く。
  • "make html"とだけ書いたバッチファイル作って楽しよう。
  • _build/htmlの中身にショートカット作って楽しよう。
  • バージョン管理はsubverionとかgitとかMercurialとか？
    • 例 : http://togakushi.bitbucket.org/bitbucket.html

• 描画補助

  • Sphinxは、何故か文字列こねくり回してダイアグラム書いちゃおうぜ、なノリが実装されてる。
  • まずは試してみる
    • http://interactive.blockdiag.com/
  • いろいろ書いてある
    • http://docs.ssm.myz.info/yakumo3/index.html
  • blockdiag
    • http://blockdiag.com/blockdiag-ja/build/html/index.html
    • ブロックダイアグラム生成ツール。
      • 単品で使う
        • easy_install blockdiag
    • sphinxと組み合わせて使う
      • easy_install sphinxcontrib-blockdiag
      • conf.pyに追記
        

        extensions = ['sphinxcontrib.blockdiag']
        blockdiag_fontpath = 'C:\windows\fonts\meiryo.ttf
        

  • windowsで使用する場合は、今でも問題が起きるかもしれない。
    • http://99blues.dyndns.org/blog/2011/01/blockdiag_for_win/
  • 文字の折り返しってどうやるんだろう。
  • 文字量に応じてサイズを可変にするのってどうやるんだろう。
• nw-diag
  • ネットワーク図生成ツール
• block-diag
• seq-diag
  • シーケンス図生成ツール
• sphinx_rtd_theme
• recommonmark
• sphinx-markdown-tables
• sphinx-markdown-parser
• actdiag
  • 業務フロー生成ツール
• graphviz
  • 単品でも割と有名なダイアグラム生成ツール
    • DOT言語使うアレ
• とても参考になる
  • http://yutuki.blogspot.jp/2012/01/sphinxhtmlpdf.html