mirror of https://github.com/phonopy/phono3py.git
address @atztogo PR comments
This commit is contained in:
parent
ece67a3201
commit
692dcce073
|
@ -4,7 +4,7 @@ This directory contains python-sphinx documentation source.
|
|||
|
||||
## How to compile
|
||||
|
||||
```sh
|
||||
```bash
|
||||
make html
|
||||
```
|
||||
|
||||
|
@ -17,20 +17,20 @@ make html
|
|||
|
||||
Web page files are copied to `gh-pages` branch. At the phono3py github top directory,
|
||||
|
||||
```sh
|
||||
```bash
|
||||
git checkout gh-pages
|
||||
rm -r .buildinfo .doctrees *
|
||||
```
|
||||
|
||||
From the directory the sphinx doc is complied,
|
||||
|
||||
```sh
|
||||
```bash
|
||||
rsync -avh _build/ <phono3py-repository-directory>/
|
||||
```
|
||||
|
||||
Again, at the phono3py github top directory,
|
||||
|
||||
```sh
|
||||
```bash
|
||||
git add .
|
||||
git commit -a -m "Update documentation ..."
|
||||
git push
|
||||
|
|
|
@ -6,7 +6,6 @@
|
|||
:depth: 2
|
||||
:local:
|
||||
```
|
||||
|
||||
(brillouinzone_sum)=
|
||||
|
||||
## Brillouin zone summation
|
||||
|
|
Loading…
Reference in New Issue