From a90c3ddbfa7f43170a085f6de65f4d46245a9e84 Mon Sep 17 00:00:00 2001 From: Atsushi Togo Date: Sun, 22 Dec 2019 16:28:03 +0900 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++++++++--- doc/README.md | 20 ++++++++++++++++++++ 2 files changed, 37 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c8a1c91a..599c30e5 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,21 @@ [![PyPI](https://img.shields.io/pypi/dm/phonopy.svg?maxAge=2592000)](https://pypi.python.org/pypi/phonopy) [![Build Status](https://travis-ci.org/atztogo/phonopy.svg?branch=master)](https://travis-ci.org/atztogo/phonopy) -phonopy -======= +# Phonopy -Phonon code. For the details, see http://atztogo.github.io/phonopy/ +Phonon code. Phonopy user documetation is found at http://atztogo.github.io/phonopy/ + +## Mailing list for questions + +Usual phonopy questions should be sent to phonopy mailing list (https://sourceforge.net/p/phonopy/mailman/). + +## Development + +The development of phonopy is managed on the 'develop' branch of github phonopy repository. + +* Github issues is the place to discuss about phonopy issues. +* Github pull request is the place to request merging source code. + +## Documentation + +Phonopy user documetation is written using python sphinx. The source files are stored in `doc` directory. Please see how to write the documentation at `doc/README.me`. diff --git a/doc/README.md b/doc/README.md index 259686de..5285dfeb 100644 --- a/doc/README.md +++ b/doc/README.md @@ -13,3 +13,23 @@ make html * `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 in `index.rst`. * `*.inc` are the files included in the other `*.rst` files. + +## How to publish + +Web page files are copied to `gh-pages` branch. At the phonopy github top directory, +``` +git checkout gh-pages +rm -r .buildinfo .doctrees * +``` + +From the directory the sphinx doc is complied, +``` +rsync -avh _build/ / +``` + +Again, at the phonopy github top directory, +``` +git add . +git commit -a -m "Update documentation ..." +git push +```