【インターンステラ】Sphinxを試用してみる

こんにちは、國分です。

本日はドキュメント生成ツール「Sphinx」の試用について報告していきたいと思います。

チュートリアル通りにインストールから

$ sudo pip install sphinx 
Cannot uninstall 'pyparsing'. It is a distutils installed project and thus we cannot accurately determine which files belong to it which would lead to only a partial uninstall.

インストール時にこのようなエラーが出てしまったので’pyparsing’を除いてやり直し。

$ sudo pip install sphinx --ignore-installed pyparsing 
プロジェクト作成
$ sphinx-quickstart 
いくつかの質問に答えて作成完了。             shinx-quickstartの詳細についてはこちら
雛形ができたのでページを追加します。
ファイルが完成したら下記コマンドの
$ make html 
でHTMLファイルが出来上がっていました。
index.htmlを開いてみると右画像のようにシンプルにまとまっていました。
初めての私でも簡単なことはできそうです。チーム運用するには壁があるそうですが、検討しても良いのではないかと感じました。reST(reStructuredText)記法も大きな問題ではなさそうです。
運用となったら面倒を省くために書き換えも出来たらと考えています。

次回はGitLab+SphinxでHTMLを閲覧する方法について

タイトル

本文