インラインマークアップ前後にスペースを入れたくない¶ Sphinxが使っているreSturucturedTextでは、インラインマークアップの前後にスペースが必要でした。スペースなしでは単語の区切りを認識しないため、インラインマークアップが無視されます。
インラインマークアップ前後にスペースを入れたくない¶ Sphinxが使っているreSturucturedTextでは、インラインマークアップの前後にスペースが必要でした。スペースなしでは単語の区切りを認識しないため、インラインマークアップが無視されます。
Sphinxでlatexpdfjaコマンドを使ってPDFをビルドするには、latexのインストールされた環境が必要になります。 Ubuntuだとtexlive-fullパッケージで必要なパッケージをインストールできるっぽいというのを把握しました。 texlive-fullは依存パッケージがたくさんありサイズが大きいので、Dockerイメージにして使い捨てすると良さそうだと思いました。 調べたらすでに同じようなことをやってる人がいたんですが、Sphinx拡張などいくつか欲しいものが足りなかったので、自分で作ってみました。 DockerHubに置いときました。 tokibito/sphinx-texlive - Docker Hub 使い方 イメージのサイズが圧縮状態で3GBぐらいあって大きいので、試す際はご注意ください。 Sphinxのプロジェクトのディレクトリに移動して以下のコマンドを実行
はじめに 清水川貴之です。 2015年6月5日（金）～7日（日）にかけて、台北でPyCon APAC 2015が行われました。PyCon APAC はAPAC（アジア太平洋）地域の国で年ごとに行われるPythonのカンファレンスです。2010年からシンガポールで開催され、2013年には日本で、昨年と今年は台湾で開催されました。筆者はこのイベントで、Sphinxの機能を紹介する2つの発表を行ってきました。 Sphinxは、reStructuredText記法のテキストやPythonソースコードから、HTMLやPDFなどのさまざまな形式のドキュメントを出力するドキュメンテーションツールです。Python標準ライブラリのドキュメント作成のために作られたツールで、PythonライブラリであればSphinxでドキュメントを書くのが一般的、というくらい多くのPython関連ツール、ライブラリで利用
A project Download 現在のバージョン: 1.4.4 Python Package Indexからソースコードをダウロードするか、以下のコマンドでインストールしてください: pip install -U Sphinx 疑問? 意見? Googleグループのsphinx-users グループへの参加 もしくは、FreeNodeの#sphinx-docチャンネルへどうぞ。 何か気づいたことがあれば、issue trackerを使用して報告することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。Pythonのプロジェクトのためのすばらしい機能を提供してきましたが、現在ではC/
はじめに こんにちは、Python界の情弱です。最近は色々とPythonの開発環境も変化してきていて、ようやくPython2.xとPython3.xを行き来しながら開発する体制が整ってきたという印象を受けています。ここしばらくは色々と試していたのですが、ようやく鉄板っぽい方法にたどり着いたのでメモしておきます。 なお、後半はPythonに限らない内容なので、他のLLを使っていても使えそうかなと思っています。この環境を設定すると何ができるのかというと、以下のことすべてが、無料で、自鯖を立てることなく行えます。 開発環境の整理（virtualenv） ローカルでの複数環境のテスト容易化（tox+pytest） CIによるテスト（Travis-CI） ドキュメントの自動ビルドおよびドキュメントの公開（ReadTheDocs） 概要 とりあえず全体像を先に共有しておきます。ちょっとでかいですがご了
Python Web フレームワーク アドベントカレンダー2010のバトンが回ってきましたので、書いてみます。 Sphinx version 1.1から、WebSupportというものが入りました。これは、sphinxのドキュメントをWebサーバにつなぎ、コメントや変更の提案、投票といった機能を追加してくれます。 これ単体だとWebフレームワークとは言い切れませんが、まあ誤差の範囲ということで許してください。 概要把握: 動作している様子 WebSupport開発者のJacob Masonさんが提供しているデモサイトです。これを見て雰囲気を掴んでください。 http://www.jacobmason.com/demo/contents ちなみにこのソースはbitbucketで公開されています。 必要なライブラリ WebSupportはコメントなどをsqliteのDBに保存しますので、それを
このスライドについて¶ このプレゼンテーションは S6 (c) 2007 Cybozu Labs, Inc. Sphinx S6 Sphinxテーマ で作成した、Sphinx S6テーマ利用サンプルです。
9月10日、大田区産業プラザPiOにて「PHPカンファレンス2011」が開催されます。本稿では、本イベントの各セッションの模様を随時更新の形式でレポートしていきます。 会場設営が大分終わり、参加者の皆さんを待っているメイントラックのホールです。 今年のスタッフTシャツです。 会場に来られない方のために、ベストエフォートでUstreamによる中継が行われています。各トラックのチャンネルは以下のとおりです。 メイントラック ギークトラック テックトラック 廣川類さん「基調講演」 PHPカンファレンス2011は、PHPユーザー会の廣川類さんによる基調講演で幕を開けました。 まずは「PHPの歩み」として、PHPがブレイクしたきっかけとなったバージョン4から現在の5.3についてのおさらい、そして次期バージョンの5.4についての解説が続きます。PHP 5.4では、10～15%のパフォーマンス改善、コー
id:rokujyouhitoma さんに誘われてPyPyの翻訳を始めました。 PyPy本家の資料がSpinxで書かれているため、翻訳ももちろんSphinxで行っています。 参考 Sphinxの魔法にかかってみた - ふぞろいのGENGOたち Sphinxの実行環境をつくる インストールするパッケージ Sphinxの導入 Sphinxの実行環境をつくるを参考にしてbuildoutでSphinxをインストールする。 Pythonは標準で入っているものを使えばok. ↓みたいにaliasでsphinx-buildのパスを設定しておくとベター alias shinx-build='/path/to/sphinx-build' OMakeの設定 OMakeってなに？って人はこちらを見ると良いかと => OMake つかったらC言語でプログラム書く手間がバカみたいに減った - 日記を書く [・w・]
Sphinxの国際化機能を使って複数言語用ドキュメントを用意する方法（概要）で示した複数言語用ドキュメントを用意する仕組みの使い方を紹介します。本当は仕組みについて説明するつもりだったのですが、使い方を書いていたら長くなったので分けることにしました。この仕組みは実際にgroongaで使っているもので、以下のような使い方になります。 ドキュメントを英語で書く。 他の言語への翻訳をPOファイルに書く。 それぞれの言語毎にHTMLを生成する。 まずファイル構成を紹介して、その後、実例を示しながら具体的な作業を紹介します。 ファイル構成 まずファイル構成です。これで概要を掴んでください。 groongaはAutomakeなどのGNUビルドシステムを利用しているため、このような構成になっています。違うビルドシステムを利用している場合は違う構成にした方がよいかもしれません。その場合でも英語を特別扱いせ
寄せ集め。社内用。元々は@IanMLewisが作ったもの。 bpxxx用のドキュメントで使ったりする。 aodag.scaffold用のscaffold。 インストール $ wget https://bitbucket.org/tokibito/beproud.project.sphinx/downloads/beproud.project.sphinx.zip $ scaffold install beproud.project.sphinx.zip beproud.project.sphinxはやくhttp経由のインストールに対応しないかなー。 使い方 $ scaffold list beproud.project.sphinx $ scaffold create beproud.project.sphinx -d NewDocument /home/tokibito/.scaffol
YARDのことの続きを書きたいと思いつつもなかなか辿りつきません。今回はPython製のドキュメントツールSphinxの話です。groongaのケースを例にしてSphinxで複数言語用のドキュメントを生成する方法の概要を紹介します。書いていたら長くなったので、具体的にどうするかというのは次の機会にします。 5/29にgroonga 1.2.2がリリースされました。今後は日本だけではなく世界でも使ってもらえるように、英語でも情報を発信していく方向になりました。そこで、今回のリリースに合わせてサイトデザインをリニューアルし、英語のページも用意しました。ただし、すでにあった日本語のコンテンツを今回のリリースで全部英語にした、というものではありません。今回のリリースでやったのは「日本語と英語という複数の言語で情報を発信する仕組み」を作るところまでです。せっかくなので、今回のリリースで導入した、Sp
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
