Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
ページ内の目次を作りたい
ページ内の目次を作りたい¶ contents を使います。 contents はページ内のセクションに対してリンクを作ります。以下のオプションが使えます。 文字列目次のタイトルを指定します。必ず他のオプションより先か、 contents ディレクティブと同じ行に書いてください。 :depth: <数値>目次に含めるセクションの深さを指定します。指定がない場合はすべてのセクションを目次に含めます。 :local:このディレクティブ以降にあるセクションだけを目次に含めます。指定がない場合はページ内のセクションをすべて含む目次を作ります。 また、このオプションを指定すると目次のタイトルがなくなりますので、別途指定してください。 :backlinks:セクションから目次に戻るリンク(バックリンク)に対しての動作を決めます。以下の引数を持ちます。 引数 動作
Sphinxに目次をつける — SXIMADA W3
Sphinxに目次をつける¶ [ページ内の目次を作りたい] では目次をつける方法が紹介されています。 それを見本にして実際に目次を付けてみました。 目次は contents ディレクティブを使います。 .. -*- coding: utf-8 -*- .. contents:: 目次 :depth: 3 :local: :backlinks: entry contents ディレクティブ¶ .. contents::¶ そのページにあるセションを集めてリンク集を作成します。 引数にはタイトルを指定できます。 例えば 目次 などがいいですが、 オリジナリティを発揮してもいいかも知れません( お品書き とか)。 オプションには次のものがあります。 :depth: <NUM> 何階層目までのセクションを対象にするかを指定できます。 <NUM> には1以上の整数を指定します。 :local: 指定
Sphinxですべての目次をサイドバーに表示する - Qiita
背景 Sphinx ってデフォルトの動作（テーマ）だとサイドバーに表示される目次って、今見ているページに関連する目次のみで全体の目次は見えなくなってしまいますね。 でも、Sphinx-Users.jp ではサイドバーに表示されている目次ってすべてが表示されていて、いつも同じになっているので、これと同じようなことをしようとしたときのメモです。 なお、Sphinx を使い始めたばかりなので、間違いあれば指摘いただけると嬉しいです！ 情報 本家の情報では、どのようにすれば... の 「... すべての全体の目次をサイドバーに表示できますか？」にさらっと書いてあります。 が、これでは自分には理解しきれなかったので、Sphinx-Users.jp のソース を見ました。これから得られた知識をもとにして以下を書いています。 やり方 目次用テンプレートの作成 sphinxプロジェクトのソースディレクトリ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
