Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx （スフィンクス）の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
ダウンロード このドキュメントはバージョン1.0 (hg)のためのものです。まだリリースされていません。 Mercurialリポジトリのコードを利用するか、Python Package Indexにあるリリースバージョンを探してください。 疑問? 意見? Googleグループへの参加: もしくは、FreeNodeの#python-docsチャンネルへどうぞ 何か気づいたことがあれば、issue trackerを使用して通知することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。そして、今までに数々のPythonや、他の言語で開発されているプロジェクトに対して、すばらしいドキュメンテーシ
http://sphinx-users.jp/event/20101203_jus_benkyoukai.html 日本UNIXユーザ会 2010年12月勉強会 (2010/12/3) 日本UNIXユーザ会の2010年12月の勉強会にて、以下の内容で発表させていただきました。 「ドキュメントを作りたくなってしまう魔法のツール Sphinx」Read less
Sphinx-Users.jp
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx （スフィンクス）の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
B! 139 0 0 0 最近良くGitHubなんかで公開されてるオープンソースのドキュメントを見ようとすると こんな感じの似たようなフォーマットで書かれているものが多くなっています。 余りに多いので最初GitHubのサービスかな、とか思ったんですが、 これはまた別のRead the Docsという ドキュメント用ホスティングサービスによるものでした。 Read the Docs Read the Docsでドキュメントを公開してみる Sphinxのインストール レポジトリ側の準備 Read the Docsへの登録 ページを作成 Indexページ ページ内容の編集(Markdown to reStructuredText) タイトル ハイパーリンク 画像 リンク付き画像 インラインマークアップ コードブロック リスト テーブル Pythonのモジュール説明 その他reStructured
Sphinx makes it easy to create intelligent and beautiful documentation. Here are some of Sphinx’s major features: Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information Hierarchic
Sphinxをはじめよう
本書には改訂版があります。 Officeツールを使用していて、思うようにならずストレスを感じる事はありませんか？あるいは、印刷用の資料を見ている時に、Webブラウザで閲覧しやすいフォーマットになっていて欲しいと思ったりはしませんか？ 本書はPythonで標準的なドキュメント作成ツールとして利用されているSphinxの入門書です。Windows、OS X、Linux（Ubuntu）を例に、Sphinxの概要からインストール、基本的な利用法について。またSphinxからLaTeXを経由してPDFを作成したり、EPUBフォーマットの電子書籍を作成する方法を、初めて触れる方にもわかりやすく紹介しています。 なお本書はEbook版のみの販売となります。 はじめに 本書を読むにあたって必要な環境とバージョン 本書が想定する読者 本書で使用されている表記規則 サンプルコードの使用について 本書に関するお
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
鈴木たかのり（@takanory）です。今月の「Python Monthly Topics」では、Python製の静的サイトジェネレーターSphinxを使用してWebサイトを構築し、テーマを適用、外部へ公開する流れについて紹介します。後半ではSphinxの便利な拡張機能を紹介し、Webサイトをより便利にしていきます。 Markdownでドキュメントを書くだけで、きれいなWebサイトが簡単に公開できるので、ライブラリのドキュメントなどでもよく使われています。 Sphinxとは SphinxはPython製の静的サイトジェネレーターです。静的サイトジェネレーターとは、Markdown等の軽量マークアップのテキストファイルから、静的なWebサイトを生成するアプリケーションのことを言います。Python製の静的サイトジェネレーターにはSphinxを含め以下のツールなどがあります。 Sphinx：h
Who is the person whom the IT engineers should learn next to Alexander?Yoshiki Shibukawa
Sphinxを、MercurialとPandocを組み合わせて Markdown記法で運用できるようにしたお話。
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 この前のブログのエントリーにも書きましたが、Sphinxというステキすぎるツールがあります。ドキュメントがどんどん書きたくなっちゃうステキなツールです。ですが、残念ながら、使用するためにはインストールする必要があります。Pythonって何？という人には少々敷居が高いため、解説の記事を書いてみました。 [STEP 1] Pythonからインストールする場合 WindowsではPythonからインストールする必要があります。一発でインストールできる環境を持っている人は最後の方のインストール法に飛んでください。また、Mac OS Xみたいに、最初からPythonから入っている人は[STEP 1]は飛ばしてください。 Windwsの場合 http://python.orgを開きます。P
Sphinx + blockdiag で始めるドキュメント生活 @ yokohama.pm 2011/05 | Webシステム開発／教育ソリューションのタイムインターメディア
システムインテグレーション、教育機関向けICTソリューションならタイムインターメディアにおまかせください。 あらゆるITニーズに対して豊富な業務知識と卓越した技術力でお答えします。 株式会社タイムインターメディア 〒160-0002 東京都新宿区四谷坂町12-22 TEL:03-5362-9009 / FAX:03-5362-9008
Docker imageを用意してWindows/macOSでスムーズに同人誌を作った話（Sphinx編） - once upon a time,
こんにちは、ハイラルに移住したchezouです。最近は、Rから始まりRで終わる言語をよく書いています。 いよいよ明日に迫ってきた技術書典2ですが、お-13で技術書供養寺として頒布を行います。 内容は、僕の機械学習の実務におけるtipsとfastFMを使った推薦、@tokorotenさんのKickstarterの分析、@hagino3000さんのスプラトゥーンのデータマイニングということで盛り沢山です。初めての同人誌ですが、140ページを超えた薄くない薄い本になりました。 是非買いに来てください！ tl;dr 技術書を書くときに、LaTeXを含んだDocker image使ってCIでビルド出来るようにすると共同執筆が捗るよ 前回までのあらすじ 今回は、メンバーがWindowsの人とmacOSの人の混成チームであったこと、全員がPythonに馴染み深い人だったので、reStructuredTe
1月11 ゼロからはじめるSphinx《入門編》 カテゴリ:Ubuntu 11.10TeX Sphinxは、HTML文書・LaTeXを用いたPDFファイル・EPUB形式の電子書籍などを同一のソースファイルから作成できるドキュメント作成プログラムです。通常のプログラムのコンパイルのように、makeコマンドを使ってそれぞれの形式の文書を作成します。 Sphinxのソースファイルは、reStructuredText（拡張子は .rst）と呼ばれるマークアップ言語で記述します。以下に、サンプルをお見せしますが、これらはすべて特別なレイアウト調整を行っておらず、デフォルトのレイアウトを使っています。このように、非常に完成度の高い多様な文書が同一のソースから作成できるというのは魅力的ですね。 以下、Ubuntu 11.10(oneiric)でSphinxを使ってみたという備忘録です。 詳細は、Sphi
今後、マニュアルを書いてメンテナンスも継続的にしていく機会が丁度ありそうなので、現時点(2012/05/02)でどのツールが自分たちにフィットするか検討してみた。ツールの候補は以下。なお、過去の仕事ではWordとDocBookは経験あり。 Word DocBook Sphinx ReVIEW 前提 今回のマニュアル作成の前提は以下の通り。 複数人で作業し、1つのドキュメントを作成する(主に章単位でアサイン)。 特定顧客向けに部分的にカスタマイズして提供することもある。 外部向けのドキュメントなので、体裁はそれなりに整っている必要がある。 製品のエディションによってマニュアル構成が変わる(上位のエディションだと機能が増えるので章や節、説明が増えるなど)。 出力フォーマットはWordまたはHTMLならOK。PDFは必須ではない。 ドキュメント中に画像はそれなりにある。スクリーンキャプチャ、構成
Sphinxを使って論文っぽい文章を書くときのtipsをまとめておきます。 追記: この内容は Sphinx逆引き辞典により詳細にして載っています。 用語を書く際はreplaceを使う .. |hoge| replace:: ほげらこう定義しておくと次からは |hoge| とするだけで、ほげらと自動的に展開してくれます。つまり、あとからこの用語名を変えたいな、と思ったときにはこの定義のところだけを変えれば勝手に全部入れ替えてくれる、というわけです。 ただし、複数のrstファイルに分けている場合には使えないので、別のファイル(例えばdefinition.txt)に replace を書いておき、 .. include:: definition.txtと各rstファイルの先頭に書いておきます。この時、.rstではなく.txtなど他の拡張子のファイルに書いていることに注意してください。そうしない
1. コーディングスタイルを知る PEP8 – Style Guide for Python Code PEP257 – Docstring Conventions Pythonコミュニティが推奨するスタイルが存在する PEP 8 -- Style Guide for Python Code via http://legacy.python.org/dev/peps/pep-0008/ インデントはスペース4 行の長さ最大79文字 import分の順序 命名スタイル etc .. PEP 257 -- Docstring Conventions via http://legacy.python.org/dev/peps/pep-0257/ ツールでチェック pep8 … pepe8のチェック pep257 … pep257のチェック pyflakes … 文法エラーなどをチェック flak
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 前回、インストールのエントリーを書きましたが、Tornadeドキュメントの翻訳を例に、実際にSphinxでの作業の流れをお見せしたいと思います。 まずはワークフォルダを作る 作業をするには、ファイルを置く場所が必要です。ソースコード、設定ファイル、ビルド後の成果物などなど、いろいろ必要になります。そこでフォルダを作成する必要があります。僕の場合は翻訳とかの作業は(ホーム)/work/(作業フォルダ)という場所で行うことが多いので、その前提で話しをすすめます。Tornadoの翻訳の場合はチームで作業をしたので、bitbucketを使って共有環境を用意しましたのでその説明も一緒に。 共有をする場合はMercurialをインストールしてください。Windowsの場合はTortoise
Sphinx 3.5.1 released We are starting 2023 off by making Sphinx 3.5.1 available, with about 30 new features compared to 3.4.1 released mid-2021 (it has been a little while), and almost a hundred changes and fixes. We voted internally for the top-3 features but ended up choosing top-6 to highlight on the front page. They are as follows. Read more... Sphinx 3.3.1 released We have just made Sphinx 3.
システムやアプリ開発に取り組むプログラマーの多くが苦手としているのが「ドキュメント作成」。IT業界ではいまだにWordやExcelがメジャーなドキュメントツールとして用いられているが、そもそもこれらのソフトを敬遠している人も少なくないのではないだろうか。 とはいえ、組織としてコーディングを手掛けている限り、ドキュメント作成は避けて通れない“義務”であることも事実。そこで今、面倒なドキュメント作成をよりプログラマブルに行えるツールとしてPythonistaの脚光を集めているのが、OSSのドキュメンテーションビルダー『Sphinx』だ。 『Sphinx』は、Python 3.2や3.3のリリースマネジャーとして知られるゲオルグ・ブランドル氏が開発し、BSDライセンスを通じて公開されたツール。マークアップ言語のreStructuredTextでドキュメントを書いておけば、HTMLやPDF（拡張機
Sphinx 3.5.1 released We are starting 2023 off by making Sphinx 3.5.1 available, with about 30 new features compared to 3.4.1 released mid-2021 (it has been a little while), and almost a hundred changes and fixes. We voted internally for the top-3 features but ended up choosing top-6 to highlight on the front page. They are as follows. Read more... Sphinx 3.3.1 released We have just made Sphinx 3.
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
ReadTheDocsでSphinxホスティングは磐石（になる予定） - YAMAGUCHI::weblog
はじめに こんにちは、Sphinx-Users.jpの賑やかし担当です。最近PHP界隈でも人気の高いドキュメント生成ツールSphinxですが、みなさん楽しいSphinxライフを送っていますでしょうか。さて、Sphinxでドキュメントを作った場合、一番キャッチーなのはHTMLだと思うんですが、そのホスティングはみなさんどうされていますか？ Sphinx-Users.jpにいくつかホスティングの方法を紹介してありますが、今日は割と新しいホスティング方法のReadTheDocsをご紹介します。 ReadTheDocsってなに？ Home | Read the Docs rtfd/readthedocs.org · GitHub ReadTheDocsは2010年のDjango Dashで作成されたコードを元に公開されているサービス/ライブラリです。外部に公開されているSphinxのレポジトリ（G
ドキュメントを書くのが楽しくなるPython製ドキュメント作成ツール「Sphinx」で簡単にPDFを作成する方法を紹介します。 Sphinxは1つのテキストファイルからHTMLやPDF、ePub等々をあっという間に生成してくれる素敵なツールです。 SphinxでPDFを生成する方法としては、「SphinxでPDFファイル作成」や「Sphinx & blockdiag Advent Calendar(全部俺) : ATND」の「(8日目) Sphinx から PDF を生成してみよう (rst2pdf 編)」「(11日目) Sphinx から PDF を生成してみよう (LaTeX 編)」で「rst2pdf」や「LaTeX」を使用する方法が紹介されているのですが、実際に試してみると周辺ツールの導入が大変だったり、エラーが出たりでなかなか思うようにPDFを作成できませんでした。 そこで発想を変
「Jupyter Book」プロジェクトは8月13日、最新のJupiter Bookを発表した。ブック作成でJekyllに代わってSphinxを用いるようになるなど、多数の変更が加わっている。 Jupyter Bookは演算処理コンテンツを含む素材からWebサイトやドキュメンテーション、出版レベルの本を構築できるオープンソースのプロジェクト。Python向けのインタラクティブなノートブックとしての利用で知られており、インタラクティブかつ実行可能なドキュメント向けのオープンソースのツールを構築するExecutable Book Projectの支援を受けている。なお、プロジェクトはまだベータ段階にある。 最大の変更として、ブックの作成でこれまで使用していたJekyllに代わって、Sphinxドキュメンテーションエンジンを用いるようになった。また単一リポジトリから、複数のモジュラー ツール構成
SPHINX によるドキュメント生成と、Pygment によるソースコードのハイライト - 傀儡師の館.Python：楽天ブログ
2008.03.23 SPHINX によるドキュメント生成と、Pygment によるソースコードのハイライト (317) テーマ：プログラミング言語 Python を使う(336) カテゴリ：Python SPHINX: PYTHON DOCUMENTATION GENERATOR を見る。SPHINX は、Georg Brandl 氏によって作られた Python プロジェクトのドキュメントを生成してくれるプログラム。reStructuredText のソースを HTML、Windows HTML Help、LaTeX、PDF といった出力形式で出力してくれる。reStructuredText のパースは、Docutils を使っているようだ。元は、Python Documentation のために作られて、他でも使えるように、きれいに書き直されたもののようだ。 対象となるのは、基本的に
ドキュメンテーションツール「Sphinx」をチーム運用するまでの道のり - Librabuch | sphinx_documentation_advent_calendar_2013
本エントリは、次のAdvent Calendarのために書かれたものです。 ドキュメンテーション Advent Calendar 2013 （12月15日） 取り扱う内容 株式会社ALBERTのシステム開発部では、ドキュメンテーションツールであるSphinxを積極的に活用しています。 Sphinxの導入、利用そのものは簡易に行うことができるのですが、開発部でチームとして運用するためにはいくつかの困難がありました。 そんな幾重にも張り巡らされた困難を乗り越えて、2013年11月頃から本格的に運用が出来ているなぁ、と実感するに至ったので、今回は2013年の総決算としてその変遷を綴ります。 関連資料 Pythonプロダクトを活用した開発チーム運営 in PyCon APAC 2013 - SlideShare SphinxをMarkdownで使い隊 - SlideShare Sphinxとわたし
Sphinxの全文検索を複合語に強くする
最近社内のドキュメントは殆どSphinxで書いてます。しかしどうも検索の精度が悪い、特に複合語がヒットしないと言われたので改善してみました。Sphinxのバージョンはv1.2.2です。 まずはドキュメントに全文検索機能を追加する こんな方法で追加しました。 sphinx-quickstartでドキュメント作成 conf.pyに全文検索の設定を追加 python html_search_language = 'ja' html_search_options = {'type':'default'} # build server using type:mecab
ドキュメンテーション生成ツール「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の特徴である複数言語/複数アウトプ
Sphinx のメンテナになって一年が経過した話 - Hack like a rolling stone
クリスマスが過ぎてから始まる Sphinx アドベントカレンダーへようこそ (嘘) Sphinx 大型連載第二夜です。 タイトルにある通り、Sphinx のメンテナ活動をして一年が過ぎたので、その話をします。 OSS 開発者のひとつのサンプルケースとして、何かの参考になれば幸いです。 Sphinx のメンテナ活動をはじめました 去年の 12月から Sphinx のメンテナ活動をはじめました。 Python のリリースマネージャ活動が忙しかったからか原作者の Georg の活動が鈍り、 また、その後を継いだ清水川さんも忙しくて身動きが取れなくなっていたことから、 コミット権をもらっていたことだし、パートタイムで手伝うかと思ったことがきっかけでした。 以前からコミット権は持っていたものの、一切メンテナとしての活動をしていなかったので、 徐々にチケットが溜まっていく様子に後ろめたくなったのかもし
追記GitHub Sponsors で組織がスポンサーになれるようになったため、個人アカウントから組織アカウントへ切り替えました。 月 500 ドルなぜスポンサーになったのか時雨堂では自社製品のすべてのウェブドキュメントに Sphinx を利用しています。そのため Sphinx を継続的な開発を少しでもやりやすくしてもらえるようにスポンサーになりました。 個人としても Sphinx は利用させてもらっており、今まで小宮氏への個人的なスポンサーにはなっていました。 ただ今後も Sphinx を自社製品のドキュメントとして使い続けたいという思いから、企業としてメインの開発者である小宮氏への継続的なスポンサーになるべきだと判断しました。 時雨堂がスポンサーになっている開発者Cowboy や Gun の開発者である Loïc Hoguin 氏Blend2D や AsmJit の開発者である Pet
Sphinxをはじめよう
Sphinxをはじめよう¶ Sphinxを使って、かんたんな書籍紹介のドキュメントを作っていきます。 Sphinxのインストール¶ SphinxはPythonで書かれているため、Sphinxのインストールにあたっては、Pythonのセットアップと、Sphinxのインストールの両方が必要になります。 プロジェクトの作成¶ Sphinxでドキュメントを作るには、まずはドキュメントのプロジェクトを作ります。 Ruby on Rails のScaffoldや、 Django のプロジェクトと似ていて、コマンドラインから、いくつかの質問に答えるとできあがります。 このひな形の作成と、ドキュメントのツリー構造の説明を行っていきます。
Sphinxは非常に素晴らしいドキュメント生成ツールです。 この素晴らしいツールを社内で流行らせようと頑張ったのですが、誰も使ってくれません。 みんながどんなタイミングで、Sphinxを諦めてしまうのか振り返ってみました。 reStructuredTextがわからないし、覚えたくもない デフォルトのテーマが見にくいからやめる sphinx-quickstartの設問が多すぎて途中でやめる ドキュメント作成のたびにconf.pyを編集するのが面倒なので使わなくなる ドキュメント確認のたびにmake htmlが面倒なので使わなくなる 最近はJupyterでドキュメント書くので・・・ こんなところでしょうか。 たぶん、Sphinxがいまいち流行らないのも、ここら辺が理由が大きいんじゃないかと思います。 Markdownを使う 残念ながらマークアップ言語の主流はreStructuredTextでは
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/
Sphinxの標準機能に、LaTeXを経由したPDF出力が入っています。英語の文章であれば簡単に成功しますが、日本語ではスムーズに行かないところもあります。 ここでは日本語ならではの情報を集約します。 Sphinx で利用する TeXディストリビューション¶ Sphinx で日本語文章を書く場合は文字コードに UTF-8が利用されるため、PDF を作成する際には UTF-8 対応版の pLaTeX である必要があります。内部では ebb, mendex, platex, dvipdfmx の各コマンドを利用していますので、これらが利用できる環境を用意します。 ここでは、Windows、OSX、Linux、FreeBSDなどに対応しており、環境の作りやすさを考慮して、TeX Liveというディストリビューションを使って説明をしていきます。
はじめに 最近ドキュメントの整備が最優先重要課題になってきたので、ドキュメントを効率よく書くための方法を調査していました。 年初くらいから調査していて、 「ドキュメントを作りたくなってしまう魔法のツール Sphinx」 とか 「遷移図生成ツール blockdiagの紹介]」 とか 「本当のドキュメントと向き合えますか」 を見て ようやく「Sphinxにしよう！」と決心したので、Windows環境にSphinxを導入してみました。 そこで、この記事ではWindows環境にSphinxを導入するための手順を紹介したいと思います。 記事の作成にあたって、次のサイトを参考にさせていただきました。 「blockdiag を WindowsXP で動かす」 「OmakeでSphinxを自動継続ビルドしてみよう」 目標 この記事では、次のことが実現できる環境を構築します。 Sphinxを使って、テキスト
Sphinx 文書に markdown フォーマットを利用する - Hack like a rolling stone
この記事は Sphinx アドベントカレンダーの 19日目です。 markdown と Sphinx (reST) Sphinx では文書を書く際の記述フォーマットに reStructured Text を利用していますが、 世を広く見回すと、github 然り、bitbucket 然り、様々な場所で markdown フォーマットが利用されています。 markdown フォーマットは reST と比べると表現力が低い上、表現を拡張することができないという点が指摘されています。 表現を拡張することができないため、いくつかの方言が存在するという問題もあります。 ですが、reST と比べてシンプルで、なおかつポピュラーに利用されているフォーマットであるため、 新しく Sphinx に触り始める人の取っ掛かりとしては、markdown はうってつけのフォーマットと言えます。 sphinxcont
ダウンロード このドキュメントはバージョン1.0 (hg)のためのものです。まだリリースされていません。 Mercurialリポジトリのコードを利用するか、Python Package Indexにあるリリースバージョンを探してください。 疑問? 意見? Googleグループへの参加: もしくは、FreeNodeの#python-docsチャンネルへどうぞ 何か気づいたことがあれば、issue trackerを使用して通知することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。そして、今までに数々のPythonや、他の言語で開発されているプロジェクトに対して、すばらしいドキュメンテーシ
Sphinxでドキュメントを書いたりしています。 以前からシーケンス図やブロック図を描くのに それぞれ mscgen や graphviz といったツールを使っています。 これらのソフトウェアは、テキスト形式で定義を記述する（dot形式というらしい）と画像を生成してくれます。 単純に画像を作るだけならMicrosoft VisioやOmniGraffleでいいのですが、 テキストベースでドキュメントを書いている場合、いろんなアプリケーションを 横断しなくてはならず、ちょっと面倒なんですよね。 mscgenやgraphvizを使えばテキストファイルのみで管理することができるというわけです。 で、本題。 Sphinxにはこれらの拡張が用意されています（標準ではないです）。 拡張を導入することでSphinxドキュメント内にdot記述をすることが出来るようになります。 http://package
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Sphinx-Users.jp :: ドキュメンテーションツール スフィンクス Sphinx-users.jp
Overview — Sphinx v1.0 (hg) documentation
ドキュメントを作りたくなってしまう魔法のツールSphinx
Read the Docs(Sphinx)でオープンソースのドキュメントをいい感じに書いてみる
Overview — Sphinx v1.0.7 documentation
Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
Python製静的サイトジェネレーターSphinxでWebサイトを構築して公開 | gihyo.jp
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
SphinxをMarkdownで使い隊
Shibu's Diary: Pythonって何？という人のためのSphinxインストール入門
独学Linux : ゼロからはじめるSphinx《入門編》
ドキュメント作成ツールの検討(Sphinx、ReVIEWとか) - wadahiroの日記
reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。
リファクタリングツールあれこれ 〜 Sphinxと戯れたいあなたに送る入門編 〜
渋日記: Pythonって何？という人のためのSphinxチュートリアル
Sphinx | Open Source Search Engine
OSSをHackしてキャリアが広がる～海外生まれのドキュメントツール『Sphinx』を開発・運営する日本人メンバーに聞く - エンジニアtype
Sphinx | Open Source Search Engine
Sphinxで素早く簡単に綺麗な日本語のPDFを作成する方法 - (DxD)∞
最新の「Jupyter Book」を発表、Sphinxがベースに | OSDN Magazine
時雨堂は Sphinx の開発者である小宮健氏のプラチナスポンサーになりました
Sphinxを便利にして、みんなに使ってもらいたい - Qiita
Overview — Sphinx v1.0.6 documentation
LaTeX経由でのPDF作成 — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会
Sphinxの魔法にかかってみた - ふぞろいのGENGOたち
Overview — Sphinx v1.0 (hg) documentation
Sphinxでmscgen / graphviz | Go for it!