Gitlab CIを使ってSphinxのドキュメントを自動でPDFにビルドする - once upon a time,
gitlab.comは自前でDocker image登録できたり、CI持っていたりと便利ですね。しかも、privateレポジトリもお金かからないという太っ腹。 技術書典2に向けたレポジトリはgitlab.comで管理しています。 今回は共著者にPython使いが多いためSphinxを使って書いているんですが、Sphinxはcommon markでも書けるのでmarkdownでも文章を書くことが出来ます。 前回の記事では、数式入りのmarkdownからPDFを生成するDocker imageを作りましたが、それを使うと簡単にGitlab-CIでPDFが生成できます。 chezou.hatenablog.com やり方は簡単、あなたのSphinxのプロジェクトに、以下のような.gitlab-ci.ymlを書くだけ。もちろん、必要に応じてpathsは変更してください。 image: chezou
SphinxドキュメントをDockerでビルドする
先日GitHubで嬉しいアップデートが行われ、 masterリポジトリの/docs以下をGitHub Pagesで公開できるようになりました。 これまでGitHub Pagesを利用するにはgh-pagesブランチを作成する必要がありましたが、プロジェクトのソースコードと一緒にドキュメントを管理できようになったのはかなり嬉しいです！ そこで今回は、以前書いたAndroidアプリをDockerでビルドする記事をもとに ドキュメント生成ツールであるSphinxのビルドをDockerでやってみました。 これでプロジェクト用のドキュメントを作ってじゃんじゃん公開していきましょう。 Sphinxとは SphinxはPython製のドキュメント生成ツールです。 ドキュメント生成ツールとしてはかなり有名でして、Pythonの公式ドキュメントでも利用されています。 基本的なドキュメント作成の流れとしては、
reStructuredText入門 — Sphinx 1.4.4 ドキュメント
reStructuredText入門¶ このセクションは、reStructuredText(reST)の考え方や文法についての短いイントロダクションです。Sphinxユーザがドキュメントを作成するために十分な情報を提供します。reSTはシンプルに設計された、控えめなマークアップ言語ですので、理解するのにそれほど時間はかからないでしょう。 段落(パラグラフ)¶ 段落(ref)はreSTドキュメントにおける、もっとも基本的な要素です。段落は1行以上の空行で区切られた、シンプルなテキストの固まりです。 Pythonにおいてインデントが重要な意味を持つのと同様、reSTでもインデントは重要です。同じ段落のすべての行は、インデントを同じ高さにそろえて、左揃えにしなければなりません。 インラインマークアップ¶ 標準のreSTインラインマークアップは極めてシンプルです。 アスタリスク1つ: *テキスト*
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Sphinxの全文検索を複合語に強くする
