mirror of https://github.com/phonopy/phono3py.git
6b689aeca7 | ||
---|---|---|
.. | ||
Makefile | ||
README.md | ||
Si-JDOS.png | ||
Si-coleigplot.png | ||
Si-convergence.png | ||
Si-kaccum-MFP.png | ||
Si-kaccum-m191919.png | ||
Si-kaccum-pwscf.png | ||
Si-kaccum.png | ||
Si-kdeplot-OrRd.png | ||
Si-kdeplot-bwr.png | ||
Si-kdeplot-gnuplot.png | ||
Si-kdeplot-hsv.png | ||
Si-kdeplot-jet.png | ||
Si-kdeplot-seismic.png | ||
Si-kdeplot.png | ||
auxiliary-tools.rst | ||
changelog.rst | ||
citation.rst | ||
command-options.rst | ||
conf.py | ||
crystal.rst | ||
cutoff-pair.rst | ||
direct-solution.rst | ||
examples.rst | ||
external-tools.rst | ||
hdf5_howto.rst | ||
index.rst | ||
install.rst | ||
interfaces.rst | ||
output-files.rst | ||
qe.rst | ||
tips.rst | ||
turbomole.rst | ||
vasp.rst | ||
workload-distribution.rst |
README.md
How to write phono3py documentation
This directory contains python-sphinx documentation source.
How to compile
make html
Source files
conf.py
contains the sphinx setting confiuration.*.rst
are the usual sphinx documentation source and the filenames without.rst
are the keys to link from toctree mainly inindex.rst
.
How to publish
Web page files are copied to gh-pages
branch. At the phono3py github top directory,
git checkout gh-pages
rm -r .buildinfo .doctrees *
From the directory the sphinx doc is complied,
rsync -avh _build/ <phono3py-repository-directory>/
Again, at the phono3py github top directory,
git add .
git commit -a -m "Update documentation ..."
git push