2018年4月頃に行うSphinxをCentOS7/Dockerにインストール

3600 ワード
Docker Sphinx centos7 Sphinx テキストリンク

はじめに

Docker知ってる人的には察しが付くと思うけど、
残念ですがCentOS7要素は無いです。
ただ単に基底OSがCentOS7なだけです。

前提

  • CentOS7
  • Docker導入済
  • Debian系のCUIコマンド(apt-getとか)

DockerにSphinxを閉じ込める

空のコンテナという名の檻

  1. 公式のDebianベースイメージを取得し
  2. イメージを元にコンテナHogeSphinxを作成&起動
  3. 起動したコンテナにレッツ入場
shell>
docker run -it --name HogeSphinx debian:stretch-slim /bin/bash

スフィンクスを入れる

  1. パッケージマネージャーを更新
  2. pythonを入れる
  3. pythonのツール入れる
  4. 文書作成パッケージ入れる(sphinxが依存)
  5. sphinxを入れる
コンテナ内のshell>
apt-get update
apt-get -y install python-pip
apt-get -y install python-setuptools
apt-get -y install pandoc
apt-get install python-sphinx

すふぃんくする準備をする

  1. ドキュメント用のディレクトリ作成
  2. 中に入る
  3. 高速ですふぃんくする宣言
  4. 基本Enter連打。たまに質問に答える
    1. プロジェクト名
    2. バージョン
    3. 著作者
コンテナ内のshell>
mkdir Hoge
cd Hoge
sphinx-quickstart
sphinx-quickstart中のshell>
> Project name: Hoge
> Author name(s): Hoge
> Project version: 1

早速すふぃんくする

なにごともこの世界へようこそが大事。
とゆーわけですふぃんくす流を見る。
まずはhtml。

コンテナ内のshell>
make html

_buildにできますが、コンテナ内だから見れねーな！
いったんコンテナ外に出ます。

コンテナ内のshell>
exit

コンテナ外に出るとコンテナが停止するので～
1. コンテナ起動
2. コンテナ内にある_buildをお外に持ってくる。

shell>
docker start [コンテナID]
docker cp [コンテナID]:/Hoge/_build/ /Sphinx/

あとはWebブラウザに_buildの中にあるindex.htmlを投げればOK。
こんな感じにでるよ。