Update document for v1.18.2

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/README.md

@@ -0,0 +1,34 @@
+# 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 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/ <phonopy-repository-directory>/
+```
+
+Again, at the phono3py github top directory,
+```
+git add .
+git commit -a -m "Update documentation ..."
+git push
+```

doc/changelog.rst

@@ -3,6 +3,12 @@
 Change Log
 ==========
 
+Dec-22-2019: Version 1.18.2
+---------------------------
+
+- Initial version of phono3py loader (``phono3py.load``) was
+  implemented. See docstring of ``phono3py.load``.
+
 Oct-17-2019: Version 1.18.1
 ---------------------------
 

doc/conf.py

@@ -51,7 +51,7 @@ copyright = u'2015, Atsushi Togo'
 # The short X.Y version.
 version = '1.18'
 # The full version, including alpha/beta/rc tags.
-release = '1.18.1'
+release = '1.18.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -216,7 +216,7 @@ html_theme_options = {
     # Options are nothing with "" (default) or the name of a valid theme
     # such as "amelia" or "cosmo".
     # 'bootswatch_theme': "united",
-    'bootswatch_theme': "cosmo",
+    'bootswatch_theme': "Cerulean",
 
     # Choose Bootstrap version.
     # Values: "3" (default) or "2" (in quotes)

setup.py

@@ -304,7 +304,7 @@ if __name__ == '__main__':
               url='http://atztogo.github.io/phono3py/',
               packages=packages_phono3py,
               install_requires=['numpy', 'scipy', 'PyYAML', 'matplotlib',
-                                'h5py', 'phonopy>=2.4.0'],
+                                'h5py', 'phonopy>=2.4.2'],
               provides=['phono3py'],
               scripts=scripts_phono3py,
               ext_modules=[extension_lapackepy, extension_phono3py],