Linux カーネルでの Sphinx 利用法を見てみよう - Hack like a rolling stone
年末カウントダウン Sphinx 連載、第3弾です。 一切下準備をせずに連載を始めたので、早くも息切れをしています。 だれかと約束をしたわけでもないのに急にアドベントカレンダー的なものを始めるのは、なんだか死に急いでいる気がしてきました。 今回は、今年から Sphinx の利用者に加わったある大型プロジェクトについて紹介しましょう。 そのプロジェクトとは、世界最大級の OSS のひとつである Linux カーネルです。 現在の Linux カーネルドキュメント 今年開催された LinuxCon Japan 2016 で Linux カーネルのドキュメントに Sphinx を使うという発表がありました。 Linus Torvalds氏が登壇、「約10週間のリリースサイクルは続く」 - クラウド Watch それから約 5ヶ月。現在はどうなっているのか見てみましょう。 Linux カーネルのド
ドキュメントの継続的な開発方法 | IIJ Engineers Blog
私はソフトウェア開発を主体とするエンジニアで、 クラウドサービスの開発・運用 分散処理技術の検証とサービス利用の検討 社内の開発支援環境の開発・運用 などの業務に従事していますが、今回の記事は業務とは直接的な関係は無く、私が会社で勝手自発的に行っている取り組みについて書きたいと思います。 昨今、インターネットは生活に深く浸透し、クラウドサービスを利用することで安く簡単にWebサービスを開発、公開できるようになりました。Web技術の進化や流行の移り変りも非常に激しく、既存サービスの機能追加や新規サービスの開発は頻繁に行われています。それは弊社も例外ではありません。 このような開発の現場では、リーンソフトウェア開発への取り組みなど開発手法の最適化が積極的に行われ、様々なベストプラクティスが生みだされています。それらのベストプラクティスには、 継続的インテグレーション や 継続的デプロイメント
Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
ドキュメンテーションツール「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をはじめよう
本書には改訂版があります。 Officeツールを使用していて、思うようにならずストレスを感じる事はありませんか？あるいは、印刷用の資料を見ている時に、Webブラウザで閲覧しやすいフォーマットになっていて欲しいと思ったりはしませんか？ 本書はPythonで標準的なドキュメント作成ツールとして利用されているSphinxの入門書です。Windows、OS X、Linux（Ubuntu）を例に、Sphinxの概要からインストール、基本的な利用法について。またSphinxからLaTeXを経由してPDFを作成したり、EPUBフォーマットの電子書籍を作成する方法を、初めて触れる方にもわかりやすく紹介しています。 なお本書はEbook版のみの販売となります。 はじめに 本書を読むにあたって必要な環境とバージョン 本書が想定する読者 本書で使用されている表記規則 サンプルコードの使用について 本書に関するお
Sublime text 2でSphinxを使う
最近、評判のSublime Text 2とSphinxを使ってドキュメントを書いて見たのでおぼえがきの意味も含めメモ 事前準備 Sublime text 2のインストール 公式サイト(http://www.sublimetext.com/)から該当のOSのパッケージをダウンロードし、インストールを行う。 インストールが完了後、定番のPackage Contorolを入れる。 インストールからPackage Contorolを入れるまでの手順は以下のサイトを参考に行なった。 Sublime Text 2がプログラミング人生を変えるかも知れない http://tak0303.github.com/2012/09/25/how-to-use-sublime.html Sphinxのインストール 公式サイト(http://sphinx-users.jp/)のチュートリアルを元に ・Python3.
Sphinx-Users.jp :: ドキュメンテーションツール スフィンクス 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の
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Markdownもはじめよう
ドキュメントを作りたくなってしまう魔法のツールSphinx