Qiita Teams that are logged in
You are not logged in to any team

Log in to Qiita Team
Community
OrganizationEventAdvent CalendarQiitadon (β)
Service
Qiita JobsQiita ZineQiita Blog
2
Help us understand the problem. What are the problem?

More than 3 years have passed since last update.

@suttang

Docker suttang/sphinx-rtd を自動でビルドできるようにした

wamw Friday I/O 5日目です。
株式会社ワムウでは、毎週金曜日は 興味がある事柄に取り組み、その成果を何らかの形でアウトプットする日としています。

概要

おかげさまで先日作成した suttang/sphinx-rtd が、一部地域でご好評頂いております。

ある案件でドキュメントを書くに際して、Sphinxで構築しようと思って作成し、それは無事に完了したんですが、使い終わっての反省点として下記が残りました。

  1. ビルドコマンド毎回打つのダルい
  2. 自分でブラウザリロードするのダルい
  3. 公開手順がダルい

3は置いといて、このダルいポイント1, 2を解決するために自動でビルド・ブラウザリロードするようにしました。

エディタの拡張機能とかで解決しようとも思ったんですが、ローカルに環境を作る必要がある、とかblockdiagビルドできないじゃん、とかそういう理由でgulpで構築。

作ったもの

使い方

上記リポジトリを クローン するなり zipでおk するなりします。
その後 npm install を行い、 npm run build:dev するだけです。

ゼロコンフィギュレーションなのでなかなか便利です。

git clone https://github.com/suttang/docker-sphinx-rtd-theme-auto-build
cd docker-sphinx-rtd-theme-auto-build
npm install
npm run build:dev

するだけです。
まるで魔法。

ワンライナーでドキュメントが構築できます。

git clone https://github.com/suttang/docker-sphinx-rtd-theme-auto-build && cd docker-sphinx-rtd-theme-auto-build && npm install && npm run build:dev

よかったら使ってみてください。

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
2
Help us understand the problem. What are the problem?