Update documentation

aiida-phonopy · Jun 18, 2020 · 09faa66 · 09faa66
1 parent 9ff6efa
commit 09faa66
Show file tree

Hide file tree

Showing 22 changed files with 181 additions and 556 deletions.
diff --git a/docs/codes/index.rst b/docs/codes/index.rst
diff --git a/docs/codes/phono3py.rst b/docs/codes/phono3py.rst
diff --git a/docs/codes/phonopy.rst b/docs/codes/phonopy.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,6 +18,8 @@
 #
 import os
 import sys
+import sphinx_rtd_theme
+
 sys.path.insert(0, os.path.abspath('../'))
 
 
@@ -35,7 +37,7 @@
               'sphinx.ext.viewcode']
 
 # Add any paths that contain templates here, relative to this directory.
-#templates_path = ['_templates']
+# templates_path = ['_templates']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
@@ -48,17 +50,17 @@
 
 # General information about the project.
 project = u'aiida-phonopy'
-copyright = u'2017, Abel Carreras'
-author = u'Abel Carreras'
+copyright = u'2017, Atsushi Togo, Abel Carreras'
+author = u'Atsushi Togo, Abel Carreras'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'0.1'
+version = u'0.2'
 # The full version, including alpha/beta/rc tags.
-release = u'0.1'
+release = u'0.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -84,7 +86,9 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-#html_theme = 'alabaster'
+# html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -150,14 +154,14 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc, 'aiida-phonopy', u'aiida-phonopy Documentation',
-     author, 'aiida-phonopy', 'One line description of project.',
+     author, 'aiida-phonopy', 'Running phonopy using AiiDA',
      'Miscellaneous'),
 ]
 
-try:
-    from aiida import load_dbenv, is_dbenv_loaded
-    if not is_dbenv_loaded():
-        load_dbenv()
+# try:
+#     from aiida import load_dbenv, is_dbenv_loaded
+#     if not is_dbenv_loaded():
+#         load_dbenv()
 
-except ImportError:
-    autodoc_mock_imports = ['aiida.orm', 'numpy']
+# except ImportError:
+autodoc_mock_imports = ['aiida.orm', 'numpy']
diff --git a/docs/data/band_structure.rst b/docs/data/band_structure.rst
diff --git a/docs/data/force_constants.rst b/docs/data/force_constants.rst
diff --git a/docs/data/force_sets.rst b/docs/data/force_sets.rst
diff --git a/docs/data/index.rst b/docs/data/index.rst
diff --git a/docs/data/nac.rst b/docs/data/nac.rst
diff --git a/docs/data/phonon_dos.rst b/docs/data/phonon_dos.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,17 +1,8 @@
-.. aiida-phonopy documentation master file, created by
-   sphinx-quickstart on Sun Nov  5 19:17:56 2017.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to aiida-phonopy's documentation!
-=========================================
+Welcome to aiida-phonopy
+========================
 
 .. toctree::
    :maxdepth: 2
 
    install
-   introduction
-   data/index
-   codes/index
-   workchains/index
-
+   phonopy
diff --git a/docs/install.rst b/docs/install.rst
@@ -1,15 +1,18 @@
 Installation
 ============
 
-::
-
-   pip install -e aiida-phonopy
-
-Requirements
-------------
+The following packages are required.
 
-* AiiDA v1.0.0b6
-* phonopy v2.3.2
+* aiida-core v1.2.1
+* aiida-vasp v1.0.0
+* phonopy v2.7.0
 * seekpath
 
 Currently only aiida-vasp can be used as the calculator plugin.
+The installation can be done by
+
+::
+
+   git clone https://github.com/aiida-phonopy/aiida-phonopy.git
+   cd aiida-phonopy
+   pip install -e .
diff --git a/docs/introduction.rst b/docs/introduction.rst