Sphinxをはじめよう
本書には改訂版があります。 Officeツールを使用していて、思うようにならずストレスを感じる事はありませんか？あるいは、印刷用の資料を見ている時に、Webブラウザで閲覧しやすいフォーマットになっていて欲しいと思ったりはしませんか？ 本書はPythonで標準的なドキュメント作成ツールとして利用されているSphinxの入門書です。Windows、OS X、Linux（Ubuntu）を例に、Sphinxの概要からインストール、基本的な利用法について。またSphinxからLaTeXを経由してPDFを作成したり、EPUBフォーマットの電子書籍を作成する方法を、初めて触れる方にもわかりやすく紹介しています。 なお本書はEbook版のみの販売となります。 はじめに 本書を読むにあたって必要な環境とバージョン 本書が想定する読者 本書で使用されている表記規則 サンプルコードの使用について 本書に関するお
sphinxcontrib-webmocks
Verified details These details have been verified by PyPI Maintainers tk0miya Unverified details These details have not been verified by PyPI Project links Homepage Download Meta License: BSD License (BSD) Author: Takeshi Komiya Classifiers Development Status 4 - Beta Environment Console Web Environment Intended Audience Developers License OSI Approved :: BSD License Operating System OS Independen
omakeもmakeも使わずに、Sphinxドキュメントの継続的ビルド - Study08.net 対シンバシ殲滅用人型機動兵器
新年あけましておめでとうございます。昨年一年は自分の(体重の)成長を実感できて大変残念ですね。この野郎。今年一年は減量の方ももうちょっと頑張ろうな。俺。 というわけでタイトルの話です。既にSphinxドキュメントで「.rst」ファイルが更新されたら、自動的にビルドを走らせる方法は偉大なる先人達の手によってとっくに道が開拓されているのですが、あえてまた開拓したいと思います。というか他の方法を僕がちゃんと理解できなかったので、僕の知ってる一番簡単な方法でやってみました。 先人達の足跡 特にやり方が決まってるいる話ではないので、omakeが好きな人、Makefileだけでやりたい人とかは下記記事が参考になると思います。 OMakeでSphinxドキュメントをビルドする - 偏った言語信者の垂れ流し omake を使わずに、Sphinx ドキュメントの継続的ビルド: Addicted To Ind
HTMLテーマに独自のCSS/JSファイルを読み込ませてデザイン調整等したい
注釈 Sphinx-1.8 以前は setup() 関数を定義し、その中で add_stylesheet() を呼び出していましたが、現在では設定項目 html_css_files を使って設定します。 https://www.sphinx-doc.org/ja/master/usage/configuration.html#confval-html_css_files これでcustom.cssもHTMLから読み込まれるようになります。 同様に app_add_javascript('custom.js') を使えばJSファイルも追加できます。 Sphinx標準テーマであれば、add_stylesheetやadd_javascriptを使ってcssやjsを追加することが出来ます。
取り消し線を引きたい
取り消し線を引きたい¶ Sphinxには取り消し線(sタグ)をマークアップする記法がありません。 取り消し線を使う場合には、新しくロールを定義し、それをクラス名としたスタイルシートを用意します。 追加するロール:
Sphinxの魔法にかかってみた - ふぞろいのGENGOたち
はじめに 最近ドキュメントの整備が最優先重要課題になってきたので、ドキュメントを効率よく書くための方法を調査していました。 年初くらいから調査していて、 「ドキュメントを作りたくなってしまう魔法のツール Sphinx」 とか 「遷移図生成ツール blockdiagの紹介]」 とか 「本当のドキュメントと向き合えますか」 を見て ようやく「Sphinxにしよう！」と決心したので、Windows環境にSphinxを導入してみました。 そこで、この記事ではWindows環境にSphinxを導入するための手順を紹介したいと思います。 記事の作成にあたって、次のサイトを参考にさせていただきました。 「blockdiag を WindowsXP で動かす」 「OmakeでSphinxを自動継続ビルドしてみよう」 目標 この記事では、次のことが実現できる環境を構築します。 Sphinxを使って、テキスト
OMakeでSphinxを自動継続ビルドしてみよう
題名通りです。Sphinxっていうドキュメント作成ツールがあって、これがなかなか簡単に作れる、かつ様々なフォーマットの書き出しに対応してるのですごく使いやすい。 Sphinxについて詳しく知りたい方は以下のURLを参照すればいいような気がします。 Pythonって何？という人のためのSphinxインストール入門 しかしSphinxには自動でプロジェクトのMakefileが生成されるので簡単にビルドできるようになっているんですけど、それでもhtmlファイルをrstファイルが変更される度に自動ビルドしてくれたらもっと便利になるのにとか思うのが人の常。 というわけで、前回の記事と絡めて、OMakeでSphinxを自動継続ビルドしてみようというのが今回の記事の目的です。 まずはOMakeのインストールからまず、OMakeっていうのはGNU/BSDのmakeもどきみたいなソフトです。でも「もどき」っ
Sphinx htmlslide sample — Sphinx htmlslide sample v documentation
What is this?¶ This presentation ware generated by: Sphinx sphinxjp.themes.htmlslide plugin Original Javascript codes are here: Original code: http://jsdo.it/os0x/slide Forked code: http://jsdo.it/nabetama/k6lQ Presentation Environments¶ HTML5 ready browsers Chrome, Safari, and etc. Non HTML5 ready browsers show slide but no-animation
reStructuredText(reST)をEmacsで書く際のまとめ - YAMAGUCHI::weblog
はじめに こんにちは、非モテエンジニアです。長らくExcelで仕様書を書くのがブームらしいですが、Sphinxでドキュメントを書くと耳から脳漿垂れ流しになってしまうほど楽しくなってしまうというもっぱらの噂（俺の中で）なので、EmacsでreSTを書く際の便利機能をまとめてみました。 参照 404 Not Found 手前味噌ですが自分が関わっているSphinxの日本ユーザ会のサイトです。そもそもSphinxってなによ？Sphinx自体をどうやって導入したらいいのよ？って方はご参照ください。もちろん既にご存知の方にも最新情報含め有益な情報が満載です。 Emacs Support for reStructuredText rst.elの本家。英語ですがrst-modeについて一番詳しい説明がある場所だと思います。 rst.elの色設定 - DiaryException 色設定について詳しく説明
bitbucketにSphinxをホスティング - Block Rockin’ Codes
今回、jsonengine - Simple and ultra-scalable JSON storage on Google App Engine. No server-side coding required. - Google Project Hostingというプロジェクトのマニュアルを、日本語翻訳させて頂いたんですが、作成した翻訳(Sphinxプロジェクト)をどこに公開するかで悩んでいました。 選択肢としては、 DropBox Google App Engine レンタルサーバ なんか考えられるんですが、その辺をつぶやいていたら、GithubやBitbucketを使ったホスティングの方法についてアドバイスを頂けたのでちょっとやってみました。 今回はBitbucketを用いたホスティングする事にしたのですが、あまりにも簡単だったので紹介します。 Bitbucketでの静的ファイル
bitbucket + Sphinx + Google App Engineで自動更新サイトを作成する - YAMAGUCHI::weblog
動機 Sphinxを使って翻訳作業をしたりしているんですが、いちいち自分でビルドして、サイトに公開するのが面倒。そこで WebSocketのRFCの日本語訳を公開した時と同様にGoogle App Engineへ定期的にSphinxでビルどしたhtmlディレクトリをupするという方法を試してみた。 出来たもの とりあえずいまはこんな感じで動いています。 404 Not Found プロジェクト作成 まずはGoogle App Engine（以下GAE）のプロジェクト作成をする準備。今回はUbuntu 9.04上で環境を作ってみる。自分は一回作ったアプリケーションがあるのでいいけど、0から始める場合はまずアプリケーションの登録から。 Welcome to Google App Engine まずダッシュボードで適当にアプリケーション作成。アプリケーション作ったらSDKをダウンロード $ wg
Sphinxで作ったドキュメントのホスティング
Sphinxで作ったドキュメントのホスティング¶ 日時: 2010/09/05 更新日: 2021/04/04 作者: 渋川よしき、山口能迪、清水川貴之、うさたーん Sphinxでドキュメントを作ったら公開したいですよね？自分のホームページ作成のように、FTPを使って、プロバイダーなどで提供されている所に置くというのも当然できますが、ここではいくつか別の方法を紹介します。 Github Pagesを使ってドキュメントを公開¶ Github Pagesを使えば、個人や組織のウェブサイト、リポジトリのウェブサイトを作ることができます。 必要なもの¶ Githubのアカウント git ケース1: 個人や組織のウェブサイトの公開手順¶ ユーザ名.github.io という名前のリポジトリを作成します(ここのユーザ名は個人のアカウント名、もしくは組織名です)。 SphinxでビルドしたHTML群を登
Sphinxを使ってPDFドキュメントを生成する(続き) - azuki note
Sphinxを使ってPDFドキュメントを生成する の続きです。 SphinxはreStructuredTextという言語で記述されたファイルを元にHTMLやPDFなどのドキュメントを出力するPythonのツールです。 前回はSphinxからPDF出力を行うと日本語フォントの埋め込みに失敗するというところまででした。その後、rst2pdf単体で使用した場合には問題なかったので、rst2pdfのSphinxエクステンションに原因があるだろうと思い調査したところ、それらしいポイントは見つかったのですが、私のPythonスキルの問題もあり修正できないうちに放置してしまいました。。 今回、作業用のPCのOSをクリーンインストールしたので、環境構築から試してみたところrst2pdfのtrunkではこの問題は修正されていることがわかりました。 以下に追加・整理したWindows環境でのセットアップの手順
rst2pdf で reStructuredText から PDF を生成する : 紹介マニア
パッケージシステムを利用してのインストール fink や MacPorts を利用していれば easy_install を利用してインストールできます。 以下は fink と easy_install を利用してのインストール手順です。 sudo fink install jpeg sudo fink install freetype219 sudo fink install lcms sudo easy_install -UZ PIL sudo easy_install -UZ reportlab sudo easy_install -UZ rst2pdf curl -O http://www.ijg.org/files/jpegsrc.v7.tar.gz tar zxvf jpegsrc.v7.tar.gz cd jpeg-7 ./configure --enable-shared -
Overview — Sphinx v1.0 (hg) documentation
ダウンロード このドキュメントはバージョン1.0 (hg)のためのものです。まだリリースされていません。 Mercurialリポジトリのコードを利用するか、Python Package Indexにあるリリースバージョンを探してください。 疑問? 意見? Googleグループへの参加: もしくは、FreeNodeの#python-docsチャンネルへどうぞ 何か気づいたことがあれば、issue trackerを使用して通知することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。そして、今までに数々のPythonや、他の言語で開発されているプロジェクトに対して、すばらしいドキュメンテーシ
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
2013.02.04（月） — kaiyori 1.1 documentation
sphinxcontrib-blockdiag — blockdiag 1.0 ドキュメント
http://atnd.org/events/30708
Welcome — Sphinx documentation
http://atnd.org/events/6754