Sphinx with MarkdownSphinxCon2015 presentation slide.
Sphinx 文書に markdown フォーマットを利用する - Hack like a rolling stone
この記事は Sphinx アドベントカレンダーの 19日目です。 markdown と Sphinx (reST) Sphinx では文書を書く際の記述フォーマットに reStructured Text を利用していますが、 世を広く見回すと、github 然り、bitbucket 然り、様々な場所で markdown フォーマットが利用されています。 markdown フォーマットは reST と比べると表現力が低い上、表現を拡張することができないという点が指摘されています。 表現を拡張することができないため、いくつかの方言が存在するという問題もあります。 ですが、reST と比べてシンプルで、なおかつポピュラーに利用されているフォーマットであるため、 新しく Sphinx に触り始める人の取っ掛かりとしては、markdown はうってつけのフォーマットと言えます。 sphinxcont
商用サイトに Sphinx を導入してみた - Twisted Mind
商用の製品紹介サイトに Sphinx を導入した事について書いてみます。 結論 とりあえずの結論 非技術者でも HTML を知らずに気軽に更新できる うまくテンプレート化されているのでページ追加が簡単 静的 HTML なのでリリースが簡単 結局画像の修正が大変 文章中心のサイトじゃないと意味が無い 非技術者が Windows/Git という組み合わせを覚える必要がある 枠組みをデザイナに作ってもらえれば、社内で色々好き勝手にいじれる 導入 製品の紹介サイトを作るというプロジェクトがありました。今までは CMS 等を使ってきていたのですが、今回は思い切って Sphinx を導入することにしてみました。 Sphinx のテーマを作ってもらえれば自社内で更新が気軽に出来るし、メンテナンスコストも低くなると考えたからです。 まず、社内に Web デザイナがいないため、誰かに白羽の矢を立てる必要があ
OMakeでSphinxを自動継続ビルドしてみよう
題名通りです。Sphinxっていうドキュメント作成ツールがあって、これがなかなか簡単に作れる、かつ様々なフォーマットの書き出しに対応してるのですごく使いやすい。 Sphinxについて詳しく知りたい方は以下のURLを参照すればいいような気がします。 Pythonって何？という人のためのSphinxインストール入門 しかしSphinxには自動でプロジェクトのMakefileが生成されるので簡単にビルドできるようになっているんですけど、それでもhtmlファイルをrstファイルが変更される度に自動ビルドしてくれたらもっと便利になるのにとか思うのが人の常。 というわけで、前回の記事と絡めて、OMakeでSphinxを自動継続ビルドしてみようというのが今回の記事の目的です。 まずはOMakeのインストールからまず、OMakeっていうのはGNU/BSDのmakeもどきみたいなソフトです。でも「もどき」っ
OMakeでSphinxドキュメントをビルドする - 偏った言語信者の垂れ流し
メモ。SphinxドキュメントのビルドはOMakeの-Pオプション使うと便利だとか。 OMakeは初めて使う。debian上なのでaptでインストール。 $ sudo aptitude install omakeぐぐったらいくつか参考になるものが出てきた。 映像奮闘記: OMakeでSphinxを自動継続ビルドしてみよう Paver/SphinxとOMakeでドキュメント生成/公開を自動化する - DiaryException kuenishi / couchguide_ja / source / — Bitbucket 主にkuenishiさんのほうのを参考に、ディレクトリなど設定してみたら普通に動いた。 OMakefileとOMakerootのファイルを用意すればいいのかな。 $ omake -P htmlこれでファイルの変更を検知して自動でmake htmlしてくれる。 らくちん。
sphinx 等でドキュメントを自動生成している場合に更新を自動検知してドキュメントを再生成してくれる web サーバーをかいた - tokuhirom's blog
sphinx 等でドキュメントを自動生成している場合に更新を自動検知してドキュメントを再生成してくれる web サーバーをかいた Plack つかうとこういうの簡単にかけてよい。 use common::sense; use autodie; use Plack::Runner; use Plack::App::Directory; use FindBin; use Filesys::Notify::Simple; use Parallel::Runner; my $docsdir = "$FindBin::Bin/../../docs/"; my $htdocs = "$docsdir/_build/html/"; die "missing $htdocs" unless -d $htdocs; my $runner = Parallel::Runner->new(2); $runner
Shibu's Diary: Quick Sequence Diagram Editorがステキすぎる
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 Quick Sequence Dialog Editorというツールを見たときに「これはすごいかも」と思って、いろいろ触ってみたり、仕事で使って見たり、ドキュメントの翻訳をしたりしました。テキストベースで書いた擬似コードからUMLのシーケンス図を出してくれるというツールです。誤解を恐れずに例えると、シーケンス図専用のDoxygenみたいな。感じです。 コードを打つたびにリアルタイムに更新されるGUIが秀逸で、結構面白いです。擬似コードを使うので、マウスで絵を描くようにはできず、ナビゲーションもないので、コーディングルールを覚えないと使えないという難点はありますが(なので翻訳をした)、ルールはそんなに複雑ではないし、結果がすぐに絵になるので楽しいです。 GUIベースのツールだけど
http://www.oddments.org/wp-content/uploads/2018/07/Scale-Stack-vs-node.js-vs-Twisted-vs-Eventlet.jpg
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Sphinxjp.themes.s6 を使ってプレゼンする — docs v0.1 documentation
Sphinx + blockdiag で始めるドキュメント生活 @ yokohama.pm 2011/05 | Webシステム開発／教育ソリューションのタイムインターメディア
https://sphinx-users.jp/doc10/rest.html