Liggghts-PFMとCFDEM-PFMのマニュアルを作成

以前の記事でLiggghts-PFMとCFDEM-PFMのインストールを行いました。
通常のPublic版であれば、マニュアルがWebページで公開されているので確認しながら作業ができるのですが、PFM版ではWebページはなく、ソースから自分でHTMLを作成する必要があります。今回はその方法を共有します。今回の手順は、はリンク先の記事の方法で実施されているものとして進めます。

方法

HTMLのmマニュアルの生成は、sphinx という Python 製のドキュメント生成ツールを使用します。
まず、Python3がインストールされていない場合は、Python3をインストールします。

.sh

sudo apt-get install python3

pipをインストールし、sphinxパッケージもインストールします。

.sh

sudo apt-get install python3-pip
pip3 install sphinx
pip3 install sphinxcontrib-image

CFDEMのインストール先に移動します。
以前の記事の手順でインストールされていれば/opt/CFDEM-5になります。
LAMMPS Documentation UtilitiesというものをGithubからクローンします。
その後、クローン先のディレクトリでpythonスクリプトを実行します。

.sh

cd /opt/CFDEM-5
git clone https://github.com/ParticulateFlow/lammps-doc-utils
cd lammps-doc-utils
python3 setup.py install

まず、Liggghts-PFMのマニュアルから生成します。
Liggghts-PFMのディレクトリ内のdocに移動します。

.sh

cd LIGGGHTS-PFM
cd doc

Makefileを編集します。冒頭のSPHINXBUILDのパスを指定します。
恐らく、/home/$USER/.local/bin/sphinx-buildになると思いますが、環境によって変わる可能性があるので、sphinx-buildの場所を確認し、パスを書き換えてください。

.Makefile

# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS    =
SPHINXBUILD   = /home/$USER/.local/bin/sphinx-build

Makefileが編集出来たら、HTMLを生成します。docフォルダ内で以下スクリプトを実行してください。

.sh

make html

問題なく完了していれば、docフォルダ内にhtmlが生成されていると思います。それをブラウザで開けばマニュアルを確認することができます。
CFDEMのマニュアルについても同様の手順で作成可能です。
CFDEMcoipling-PFMディレクトリ内のdocで同じ作業をすればhtmlのマニュアルを生成できるので実施してみてください。