Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
Makefile | H A D | 17-Mar-2021 | 634 | 21 | 9 | |
README.md | H A D | 17-Mar-2021 | 741 | 35 | 25 | |
auxiliary-tools.rst | H A D | 17-Mar-2021 | 10.8 KiB | 400 | 269 | |
changelog.rst | H A D | 17-Mar-2021 | 15.9 KiB | 434 | 343 | |
citation.rst | H A D | 17-Mar-2021 | 1.5 KiB | 55 | 43 | |
command-options.rst | H A D | 17-Mar-2021 | 39.4 KiB | 1,159 | 822 | |
conf.py | H A D | 17-Mar-2021 | 11.5 KiB | 368 | 46 | |
crystal.rst | H A D | 17-Mar-2021 | 3.5 KiB | 91 | 61 | |
cutoff-pair.rst | H A D | 17-Mar-2021 | 18.5 KiB | 446 | 377 | |
direct-solution.rst | H A D | 17-Mar-2021 | 15.4 KiB | 348 | 275 | |
examples.rst | H A D | 17-Mar-2021 | 513 | 19 | 13 | |
external-tools.rst | H A D | 17-Mar-2021 | 1.2 KiB | 34 | 23 | |
hdf5_howto.rst | H A D | 17-Mar-2021 | 10.3 KiB | 343 | 238 | |
index.rst | H A D | 17-Mar-2021 | 2.6 KiB | 94 | 71 | |
install.rst | H A D | 17-Mar-2021 | 11 KiB | 328 | 230 | |
interfaces.rst | H A D | 17-Mar-2021 | 2.2 KiB | 76 | 55 | |
output-files.rst | H A D | 17-Mar-2021 | 4.1 KiB | 152 | 108 | |
qe.rst | H A D | 17-Mar-2021 | 2.4 KiB | 73 | 47 | |
tips.rst | H A D | 17-Mar-2021 | 5.7 KiB | 128 | 105 | |
turbomole.rst | H A D | 17-Mar-2021 | 3.1 KiB | 81 | 54 | |
vasp.rst | H A D | 17-Mar-2021 | 3.8 KiB | 118 | 75 | |
workload-distribution.rst | H A D | 17-Mar-2021 | 5.8 KiB | 146 | 109 |
README.md
1# How to write phono3py documentation 2 3This directory contains python-sphinx documentation source. 4 5## How to compile 6 7``` 8make html 9``` 10 11## Source files 12 13* `conf.py` contains the sphinx setting confiuration. 14* `*.rst` are the usual sphinx documentation source and the filenames without `.rst` are the keys to link from toctree mainly in `index.rst`. 15 16## How to publish 17 18Web page files are copied to `gh-pages` branch. At the phono3py github top directory, 19``` 20git checkout gh-pages 21rm -r .buildinfo .doctrees * 22``` 23 24From the directory the sphinx doc is complied, 25``` 26rsync -avh _build/ <phono3py-repository-directory>/ 27``` 28 29Again, at the phono3py github top directory, 30``` 31git add . 32git commit -a -m "Update documentation ..." 33git push 34``` 35