Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
LionetDjangoApp – アクセンスのおまけ
Sphinx でビルドしたドキュメントを公開するためのアプリケーション、 Lionet Sphinx でビルドしたドキュメントを公開するための Django アプリケーション、 Lionet を公開しました。 http://pypi.python.org/pypi/lionet/ , BSD ライセンス。 (2009/06/24 ymasuda) 最近、 Sphinx を使ってドキュメントを提供するソフトウェアプロジェクトが増えてきましたね。 テキストファイルから簡単に HTML や PDF のドキュメント配布物を作れるので、とても便利。 元が reST なので、メンテナンスや翻訳もしやすいです。 さて、Sphinx の HTML ビルダは、全てのコンテンツを相対パスで参照する HTML を生成するので、ビルドした ドキュメントはオフラインでも参照できます。私も、自分の使うソフトウェアのド
GitHub - michaeljones/sphinx-to-github: Sphinx extension & script to prepare Sphinx html output for github pages.
Sphinx to GitHub ATTENTION! This project is designed to help you get around the github-pages Jekyll behaviour of ignoring top level directories starting with an underscore. This is solved in a much neater way by creating a .nojekyll in the root of you github-pages which will disable Jekyll as described here and here. This makes this project largely useless! Thank you to acdha for making me aware o
Shibu's Diary: Pythonって何？という人のためのSphinxインストール入門
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 この前のブログのエントリーにも書きましたが、Sphinxというステキすぎるツールがあります。ドキュメントがどんどん書きたくなっちゃうステキなツールです。ですが、残念ながら、使用するためにはインストールする必要があります。Pythonって何？という人には少々敷居が高いため、解説の記事を書いてみました。 [STEP 1] Pythonからインストールする場合 WindowsではPythonからインストールする必要があります。一発でインストールできる環境を持っている人は最後の方のインストール法に飛んでください。また、Mac OS Xみたいに、最初からPythonから入っている人は[STEP 1]は飛ばしてください。 Windwsの場合 http://python.orgを開きます。P
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 のために作られて、他でも使えるように、きれいに書き直されたもののようだ。 対象となるのは、基本的に
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
blockdiag - simple block-diagram image generator — blockdiag 1.0 documentation
Sphinx + blockdiag で始めるドキュメント生活 @ yokohama.pm 2011/05 | Webシステム開発／教育ソリューションのタイムインターメディア
lowlife.jp