GitLab 10.1 に GitLab CI + GitLab Pages + Sphinx でドキュメントビルド環境を整える
Sphinxで売り物の書籍を作ってみた
『Goならわかるシステムプログラミング』をSphinxで作るにはどうするか、をSphinxCon2017で発表しました
「Sphinxをはじめよう 第二版」が出ます - Hack like a rolling stone
みなさん、Sphinx 使ってますか? Python や Linux カーネルのドキュメントでご存知の Sphinx の書籍、「Sphinxをはじめよう」が改訂されます。 今週末の #技術書典 で僕らが書いた #Sphinxをはじめよう の第二版が発売されます。しかも今回は紙媒体！(電子版もあるよ)。これからSphinxを触ってみようかなと思っている方におすすめです。細かな加筆をしているので、第一版をお持ちの方にもおすすめです。 #sphinxjp— Takeshi KOMIYA (@tk0miya) 2017年10月17日 #Sphinxをはじめよう の第二版は 1) Sphinx-1.6 に合わせて加筆 2) 基本のマークアップの説明をアップデート 3) みんな大好きmarkdownの説明をAppendixとして収録 4) 画像系のツール/サービスとの連携まわりの章を追加 とあれこれい
Sphinx ではどのようにラベルとキャプションを結びつけているのか - Hack like a rolling stone
Sphinx ではラベル記法と :ref: 記法を使って、 ドキュメントの様々な位置にラベルを張り、それを参照することができます。 .. _target: section --------- セクションへの :ref:`参照 <target>` を作ります。 さて、このとき、ラベルを貼っているのがセクションタイトルなどの場合は :ref:`target` という書き方でキャプションをリンクタイトルにすることができます。 ラベルとキャプションを認識する Sphinx は次の順序でラベルを認識します。 reST ファイルのパース処理において、ラベル記法をパターンマッチで見つける (docutils.parsers.rst.states:Body#explicit_construct()) target ノードを生成する (docutils.parsers.rst.states:Body#mak
ReStructuredText 文法まとめ - secretbase.log
Sphinxで使う軽量マークアップ言語 ReStructuredText で役立ちそうなサイトをまとめてみました。(ReStructedText基礎文法最速マスターがありそうで無かった) 文法 サイト名 説明 ReStructuredText 入門 ReStructuredText Primerの日本語訳 はやわかり reStructuredText プレーンテキストと変換結果の例がわかりやすい reStructuredText Markup Specification rstの詳細な仕様。チュートリアルや入門ではない reStructuredText入門 :: ドキュメンテーションツール スフィンクス Sphinx-users.jp よく使う記法。入門 Tips サイト名 説明 reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。 論文っぽい文章を書くときのti
Sphinx-docxbuilderでWordドキュメントをテキストから生成(Windows)
Sphinxを使ってWordファイルを出力してみる。 Wordファイルを生成するには、Sphinx-docxbuilderを使う必要がある。 今回の情報源は、sourceforgeのwikiより。 https://en.sourceforge.jp/projects/sphinx-docx/wiki/FrontPage この記事もとても参考になった。 sphinxで Wordファイル(docx)出力する．(Windows)－100ねんごの未来予想図 インストール環境# Windows 7 64bit Python 2.6 Sphinx 1.3.3 Sphinx-docxbuilderに必要なPythonモジュールをインストール# Sphinx-docxbuilderを利用するには、以下をインストールする必要がある。 sphinx lxml PIL (Python Imaging Libra
Oktavia全文検索エンジン - SphinxCon JP 2014
2015/10/31に開催されたSphinxワークショップ@関西(https://japanunixsociety.doorkeeper.jp/events/32899)の発表資料です。
テキストからHTMLやTeX,pdf,docxをつくれるSphinxがドキュメント作成にかなり便利だったのでメモ - c-bata web
Sphinxとは テキスト(reStructuredTextファイル)から各種フォーマット(HTML,ePub,Latex,pdf,docx)を作成できる。 pythonのドキュメント(http://docs.python.jp/2/)なんかもこのSphinxで作成されています。 メリット 業務での利用が増えているらしい(社内ではHTMLで共有,PDFに変換して納品といった流れ) 環境やエディタを選ばない。 ツールで自動生成しやすい 提出用pdf出力など,一つのソースから複数のフォーマットに出力できる。 目次(toctree)ベースで文書構造を作れる バージョン管理できる Jenkinsで変換,公開を自動化できる まだ詳しくはわかっていないけど,かなり便利そうなのは間違いなさそう。 早速導入してみます。 インストール(Mac OS X Mountain Lion) Pythonにはeasy
OSSをHackしてキャリアが広がる～海外生まれのドキュメントツール『Sphinx』を開発・運営する日本人メンバーに聞く - エンジニアtype
システムやアプリ開発に取り組むプログラマーの多くが苦手としているのが「ドキュメント作成」。IT業界ではいまだにWordやExcelがメジャーなドキュメントツールとして用いられているが、そもそもこれらのソフトを敬遠している人も少なくないのではないだろうか。 とはいえ、組織としてコーディングを手掛けている限り、ドキュメント作成は避けて通れない“義務”であることも事実。そこで今、面倒なドキュメント作成をよりプログラマブルに行えるツールとしてPythonistaの脚光を集めているのが、OSSのドキュメンテーションビルダー『Sphinx』だ。 『Sphinx』は、Python 3.2や3.3のリリースマネジャーとして知られるゲオルグ・ブランドル氏が開発し、BSDライセンスを通じて公開されたツール。マークアップ言語のreStructuredTextでドキュメントを書いておけば、HTMLやPDF（拡張機
Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
sphinxのPDF出力環境を構築する@Ubuntu 14.04