Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
プロジェクトを作る
プロジェクトを作る¶ Sphinxでドキュメントを作成するためには、まず「プロジェクト」を作る必要があります。プロジェクトはコマンドラインで作成しますので、Windowsの場合はコマンドプロンプト、MacやLinuxの場合はTerminal(仮想端末)を起動させます。 プロジェクトは、いくつかの設定ファイルなどが配置された、ドキュメントを保存するための専用ディレクトリです。配置するファイルなどは、Sphinxに含まれる「sphinx-quickstart」というコマンドで作成します。 sphinx-quickstart¶ 何もオプションを付けないと対話モードになり、 -q オプションを付けると非対話モードでプロジェクトが作成できます。ここでは非対話モードを紹介します。 プロジェクト名の指定: -p ドキュメントの製作者(Author name(s))の指定: -a プロジェクトのバージョン
Pandoc+MarkdownでLaTeXとSphinx(reStructuredText)を操る。 - Programming Log
2014-01-20 Pandoc+MarkdownでLaTeXとSphinx(reStructuredText)を操る。 Macソフトウェア導入 Sphinx LaTeX はじめに 最近LaTeXでレポートや論文を作るときに，Markdownで書いてからLaTeXに変換するのが流行ってるらしいです。 Markdownとは？ このブログを始めた時に知ったマークアップ言語。このブログもMarkdownで書いてる。 書きやすいし読みやすくてもう手放せない。GitHubのREADMEとかにも使われてる。 Sphinxとは reStructuredText（拡張子は .rst）と呼ばれるマークアップ言語で書かれたファイルから美しいドキュメントを簡単に生成することができる。Sphinx公式サイトやPythonのドキュメントもSphinxで書かれていることで有名。 これは僕も以前に使った事があるけど，
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
https://sphinx-users.jp/cookbook/pdf/
ReadTheDocs themeとMarkdown – 我的備忘録
Publishing sphinx-generated docs on github — sphinxdoc-test v0.1 documentation
