ドキュメントを作りたくなってしまう魔法のツールSphinxhttp://sphinx-users.jp/event/20101203_jus_benkyoukai.html 日本UNIXユーザ会 2010年12月勉強会 (2010/12/3) 日本UNIXユーザ会の2010年12月の勉強会にて、以下の内容で発表させていただきました。 「ドキュメントを作りたくなってしまう魔法のツール Sphinx」Read less
ドキュメンテーション生成ツール「Sphinx」をJavaScript向けに改良した「sphinx-js」 | OSDN Magazine
Mozillaの開発者は7月14日、ドキュメンテーションツール「Sphinx」をJavaScriptで利用するためのツール「sphinx-js」の最新版「sphinx-js 2.0.1」を発表した。大規模なJavaScriptプロジェクトで利用できるドキュメントツールだという。 sphinx-jsは、Pythonドキュメントで使われているドキュメンテーションツールであるSphinxをJavaScript向けに改良したもの。従来JavaScriptで使われていたドキュメンテーション生成ツール「JSDoc」では不十分な大規模なプロジェクト向けとしている。MozillaのJavaScriptフレームワーク「Fathom」で利用するために開発が進められたとのことで、ライセンスはMIT License。 標準的なJSDoc形式のコメントとタグを理解でき、Sphinxの特徴である複数言語/複数アウトプ
Gitlab CIを使ってSphinxのドキュメントを自動でPDFにビルドする - once upon a time,
gitlab.comは自前でDocker image登録できたり、CI持っていたりと便利ですね。しかも、privateレポジトリもお金かからないという太っ腹。 技術書典2に向けたレポジトリはgitlab.comで管理しています。 今回は共著者にPython使いが多いためSphinxを使って書いているんですが、Sphinxはcommon markでも書けるのでmarkdownでも文章を書くことが出来ます。 前回の記事では、数式入りのmarkdownからPDFを生成するDocker imageを作りましたが、それを使うと簡単にGitlab-CIでPDFが生成できます。 chezou.hatenablog.com やり方は簡単、あなたのSphinxのプロジェクトに、以下のような.gitlab-ci.ymlを書くだけ。もちろん、必要に応じてpathsは変更してください。 image: chezou
Sphinx から完全に reStructuredText を追い出した話 - Hack like a rolling stone
いくつかの記事で紹介されているとおり、 recommonmark を使うと Sphinx で markdown を使うことができます。 Software Design 2016年4月号 Markdownで始めるSphinx MarkdownでSphinxできるようになったので試してみた（前編） - 意識の高いLISPマシン Markdownで書けるSphinxの構築 - Qiita しかし、recommonmark を利用しても、ドキュメント構造(toctree)を記述するためには部分的に reStructredText を使う必要がありました。 .. toctree chapter1 chapter2 chapter3 これは、文法を拡張する仕組みを持たない markdown の (commonmark の)構造上、仕方がないのですが、せっかく markdown でドキュメントを書いてい
sphinxcontrib.httpdomain で RESTful API のドキュメントを作る - ymyzk’s blog
この記事は CAMPHOR- Advent Calendar 2014 15日目の記事です. Python 製のドキュメント作成ツールであるSphinx (公式, 日本) と, その拡張機能である sphinxcontrib.httpdomain を組み合わせると RESTful API のドキュメントを簡単に作成することができます. Sphinx とは Sphinx は Python 製のドキュメンテーションビルダーです. reStructuredText という形式でマークアップしたものをビルドして, HTML や PDF, ePub など様々な形式で出力することができます. Sphinx は Python の公式ドキュメントや様々な Python のライブラリ (Django, NumPy, SciPy, etc…) で利用されているほか, Python 以外の言語のプロジェクト (
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitLab 10.1 に GitLab CI + GitLab Pages + Sphinx でドキュメントビルド環境を整える
