Archives March 2024 February 2023 July 2020 February 2019 October 2018 March 2018 February 2018 December 2017 August 2017 July 2017 October 2016 September 2016 July 2016 June 2016 September 2015 June 2015 May 2015 April 2015 March 2015 January 2015 December 2014 November 2014 October 2014 September 2014 August 2014 July 2014 June 2014 May 2014 April 2014 March 2014 February 2014 January 2014 Decem
breathe ReStructuredText and Sphinx bridge to Doxygen. docxsphinx Sphinx extension for building Microsoft Word docx files. javasphinx Sphinx extension for documenting Java projects. numpydoc NumPy's Sphinx extensions. Releases A Sphinx changelog-generating extension. autoclasstoc Make easier-to-navigate class documentation. sphinx-autodoc-annotation Use Python 3 annotations in sphinx-enabled docst
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
Sphinx本の執筆体制について¶ この記事は ドキュメンテーション Advent Calendar 2013 の4日目の記事です。 すでにかなり時間がたってしまっておりますが、2013年9月に Sphinxをはじめよう という電子書籍をO'reilly Japan様から出版させていただきました。 もちろんSphinxで執筆しました。ここでは、その際に分かったtipsなどを共 有したいと思います。 のはずだったのですが、特別なことはなにもなく、普通にSphinxで書くだけで したので、Tipsというものはほぼありませんでした。(Sphinx後のフォント周り などでいろいろ問題があったようですが) そのため、今回はどういう体制で執筆したかについて説明したいと思います。 1. 執筆体制¶ 4人で執筆しました。 基本的に一人一章ずつ、それに加えて付録を適当に割り振って執筆していきま した。 2.
https://www.freia.jp/taka/blog/sphinx-i18n-translation-procedure-with-transifex-amazon-s3/index.html
2013/02/10 Vagrant+Chefで作るSphinx開発環境¶ category: 'Vagrant', 'Chef', 'Python', 'Sphinx' 一つ前のエントリ 2013/02/10 Vagrantで作るUbuntu-12.04環境 でVirtualBox+Vagrantを使えるようになったので、次にVagrantの プロビジョニング環境を作ります。 ここでは例としてSphinxの開発環境を作ります。Sphinxのテストのために、 おおまかに以下を整えます。 Python2.5, 2.6, 2.7, 3.1, 3.2, 3.3, pypy をインストール tex関連の動作確認をするためにtexlive をインストール bitbucketにリポジトリを置いているのでhgといくつかの拡張をインストール ついでに.vimrcと.screenrcを配置 Vagrant+
Sphinxの過去と、未来¶ 著者: Georg Brandl 日付: 2012/12/25 原文: Sphinx, past and future 翻訳: @r_rudi, @shimizukawa このエントリーは日本語の Sphinx Advent Calendar 2012 に参加してくれないかというリクエストに応えて書いています。彼らはすごいよ！彼らは今年Sphinx Conferenceを開催して、イベントには70人もの人たちが集まったんだ！ Sphinx はいまや5歳になってるし、たぶん今までの歴史を振り返り、将来を語るのに良い時期じゃないかな。 このプロジェクトは2007年前半のいつ頃かに始まった。この投稿は私がPythonメーリングリストで見つけた中で一番古い。この時、Pythonのドキュメント作成のためのソースはLaTeXで書かれていた。私は科学的な文章を書くときには絶
はじめに こんにちは。Sphinx Advent Calendar 2012 の4日目のエントリです。@tk0miyaより受け取りました。 Sphinx を使い始めてまだ日が浅いですが実際に仕事で使ってみてすばらしいツールだと今更ながら気づき、Sphinx に特化したエントリというよりも Sphinx + blogckdiag を使って仕事に使えるダイアグラムの表現方法についてご紹介します。 非プログラマでも簡単に作成ができ修正も簡単、イライラしないでサクサクと図が書けます。 ソフトウェア開発プロジェクトで作成されるドキュメント(特にマニュアルで利用)は顧客に説明するための図解を多用します。これまでの経験で Word/Excel の描画ツールをつかってがんばって作った図 調整と編集がとても大変 Visio を使ってわかりやすく綺麗に作成されているが、Word/Excel/PowerPoi
これは Sphinx Advent Calendar 2012 6日目です。@togakushi さんから受け取りました。 @togakushi さんのテーマに関するテーマ（私の表現がアレですね..）を今後参考にしながら社内のsphinxサイトをリニューアルしたいなと思う今日この頃です。 さて、@goingmywaynet です。Python使えない自称エンジニア（本業は事務屋）ですが、面白くてSphinxを利用させて頂いています。ネタの使い回しになりますが、ちょっと変わった Sphinx の使い方のご紹介です。 Tipsや技術的な内容は薄いと思いますが、お付き合い頂ければと思います。 １．Sphinx とは Advent Calendar からこられた方には説明の必要はないと思いますが、Sphinxは元々は Python というプログラミング言語のメンテナンスやAPIのためのドキュメント
Thanks to Sphinx for a kickass build system and docutils for the groundwork of multiple format output. 1 Introduction¶ Creating a PhD thesis is typically done using LaTeX. This works really well for producing a PDF, but a giant PDF file is not a great way to put documents on the web. There are solutions that exist to turn latex source files into HTML, but in my experience, they tend to produce poo
2. お前だれよ Twitter: @tk0miya 仕事 (株)タイムインターメディア所属 テクニカルオフィサ(技術責任者)として活動 参加コミュニティ Sphinx-users.jp Python mini hack-a-thon Sphinx を中心にツールを開発 blockdiag シリーズ Sphinx 拡張機能の開発 Googlechart やカレンダー機能 #bookathon 他読書会やってます 3. 祝！SphinxConJP 2012 開催！ 世界ではじめてのSphinxカンファレンスへよ うこそ 7件の発表 明日の Sprint Day でもなにかやります Enjoy Sphinx :-)
Dipus - (主にSphinx向け) 全文検索サーバー¶ Sphinxの検索はデフォルトだとJavaScriptベースであまりいけてないので、 dipusっていうのを作ってみました。これは、Whoosh というPure pythonの全文検索エン ジンを使った全文検索サーバーです。 pypi: http://pypi.python.org/pypi/dipus bitbucket: http://bitbucket.org/r_rudi/dipus dipusは、sphinxとの連携に重点をおいて開発しており、sphinxのbuilderが付 属しています。そのため、文書の登録はsphinx-buildを実行するだけで完了し ます。 ちょっとした手間でsphinxの検索をいけてるものにします。というか、まだ開 発途中なのでしたいです、ですが。 なお、dipusは会社など非公開の場所で動
The Data Desk often publishes documentation alongside its code on GitHub, a social networking site where developers share their work. GitHub’s main service — free for open-source projects — is for managing source code, but it also provides ticket tracking, wikis and a simple file-hosting service for publishing HTML pages. It’s that last trick that’s great for documentati
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
