phono3py/doc
Atsushi Togo 5817ef240c Set version 3.15.0 2025-03-04 13:10:42 +09:00
..
_static Update document and version to v2.3.0 2022-04-09 15:23:47 +09:00
Makefile Update document for v1.18.2 2019-12-22 17:49:56 +09:00
README.md address @atztogo PR comments 2025-02-05 05:41:32 -05:00
Si-JDOS.png Documentation update 2019-03-14 17:03:36 +09:00
Si-coleigplot.png Update version number (v2.1.0) and changelog. 2021-11-03 09:56:21 +09:00
Si-convergence.png Add a figure for document 2016-11-27 13:38:34 +09:00
Si-kaccum-MFP.png Refactor kaccum 2024-04-19 16:38:53 +09:00
Si-kaccum-m191919.png Documentation update 2019-03-14 17:03:36 +09:00
Si-kaccum-pwscf.png Documentation update 2019-03-14 17:03:36 +09:00
Si-kaccum.png Documentation update 2019-03-14 17:03:36 +09:00
Si-kdeplot-OrRd.png --zmax option is made for kdeplot. 2017-06-12 16:00:53 +02:00
Si-kdeplot-bwr.png --zmax option is made for kdeplot. 2017-06-12 16:00:53 +02:00
Si-kdeplot-gnuplot.png --zmax option is made for kdeplot. 2017-06-12 16:00:53 +02:00
Si-kdeplot-hsv.png --zmax option is made for kdeplot. 2017-06-12 16:00:53 +02:00
Si-kdeplot-jet.png --zmax option is made for kdeplot. 2017-06-12 16:00:53 +02:00
Si-kdeplot-seismic.png --zmax option is made for kdeplot. 2017-06-12 16:00:53 +02:00
Si-kdeplot.png Update document slightly for kdeplot 2016-11-30 20:33:09 +09:00
auxiliary-tools.md fix typos and add codespell pre-commit hooks to catch future typos 2025-02-04 13:41:45 -05:00
changelog.md Set version 3.15.0 2025-03-04 13:10:42 +09:00
citation.md Update documentation 2023-10-19 14:54:37 +09:00
command-options.md missed some 2025-02-05 05:47:27 -05:00
conf.py Set version 3.15.0 2025-03-04 13:10:42 +09:00
crystal.md Update doc 2024-08-08 11:19:11 +09:00
cutoff-pair.md missed some 2025-02-05 05:47:27 -05:00
direct-solution.md fix typos and add codespell pre-commit hooks to catch future typos 2025-02-04 13:41:45 -05:00
examples.md Update document for v2.0.0 2021-07-22 21:51:20 +09:00
external-tools.md Update document for v2.0.0 2021-07-22 21:51:20 +09:00
hdf5_howto.md missed some more 2025-02-05 05:50:52 -05:00
index.md fix typos and add codespell pre-commit hooks to catch future typos 2025-02-04 13:41:45 -05:00
input-output-files.md Update documentation 2022-03-21 11:55:36 +09:00
install.md Set version 3.11.1 2025-01-12 10:16:42 +09:00
interfaces.md Refactoring using pre-commit setting 2021-10-15 16:49:41 +09:00
phono3py-api.md Add --scattering-event-class to documentation 2022-03-23 09:14:04 +09:00
phono3py-load.md missed some 2025-02-05 05:47:27 -05:00
procedure.png Update document and version to v2.3.0 2022-04-09 15:23:47 +09:00
pypolymlp.md Update pypolymlp doc 2025-03-03 11:19:45 +09:00
qe.md Update doc 2024-08-08 11:19:11 +09:00
random-displacements.md missed some more 2025-02-05 05:50:52 -05:00
reference.md Update documentation 2023-10-19 14:11:54 +09:00
references.bib Use bibtex style reference in document 2022-11-12 23:21:14 +09:00
tc_Wigner_La2Zr2O7.png Modified documentation. 2022-07-04 13:05:29 +02:00
tips.md address @atztogo PR comments 2025-02-05 05:41:32 -05:00
turbomole.md Update doc 2024-08-08 11:19:11 +09:00
vasp.md Update doc 2024-08-08 11:19:11 +09:00
wigner-solution.md Update doc 2024-08-08 11:19:11 +09:00
workflow.md Update document 2022-03-19 21:45:03 +09:00
workload-distribution.md Set version 3.11.1 2025-01-12 10:16:42 +09:00

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 configuration.
  • *.rst are the usual sphinx documentation source and the filenames without .rst are the keys to link from toctree mainly in index.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