タグ

markdownとSphinxに関するdelegateのブックマーク (1)

  • Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO

    渡辺です。 開発者の間ではgithubMarkdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは? Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS

    Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
  • 1