Some improvement of documentation

JuDFTteam · Apr 25, 2018 · 9e17194 · 9e17194
1 parent e307e32
commit 9e17194
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 11 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -66,7 +66,7 @@
 # General information about the project.
 project = u'aiida-kkr'
 copyright_first_year = 2017
-copyright_owners = "FZ Juelich GmbH, Germany"
+copyright_owners = u"FZ Jülich GmbH, Germany"
 
 current_year = time.localtime().tm_year
 copyright_year_string = current_year if current_year == copyright_first_year else "{}-{}".format(copyright_first_year, current_year)

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,22 +1,22 @@
+#######################################
+`AiiDA`_ plugin for the `Jülich KKRcode`_
+#######################################
 
 .. image:: images/juKKR_logo_square_new.jpg
-    :width: 30%
+    :width: 20%
 .. image:: images/AiiDA_transparent_logo.png
-    :width: 60%
+    :width: 40%
 
 .. _AiiDA: http://www.aiida.net
+.. _Jülich KKRcode: http://www.judft.de/pm/index.php
 
-|
 
-#####################################
-The `AiiDA`_ plugin ``aiida-kkr``
-#####################################
-
-Welcome to the example documentation of the AiiDA-KKR plugin ``aiida-kkr``
+Welcome to documentation of the AiiDA plugin for the Jülich KKRcode!
+===========================================================================
 
 The plugin is available at https://github.com/broeder-j/aiida-kkr
 
-.. If you use this plugin for your research, please cite the following work:
+If you use this plugin for your research, please cite the following work:
 
 .. highlights:: Author Name1, Author Name2, *Paper title*, Jornal Name XXX, YYYY (Year).
 
@@ -27,6 +27,7 @@ If you use AiiDA for your research, please cite the following work:
   for computational science*, Comp. Mat. Sci 111, 218-230 (2016);
   http://dx.doi.org/10.1016/j.commatsci.2015.09.013; http://www.aiida.net.
 
+
 User's guide
 ++++++++++++
 

diff --git a/docs/source/module_guide/calculations.rst b/docs/source/module_guide/calculations.rst
@@ -5,18 +5,26 @@ Voronoi
 -------
 .. automodule:: aiida_kkr.calculations.voro
    :members:
+   :private-members:
+   :special-members:
 
 KKRcode
 -------
 .. automodule:: aiida_kkr.calculations.kkr
    :members:
+   :private-members:
+   :special-members:
 
 KKRcode - calculation importer
 ------------------------------
 .. automodule:: aiida_kkr.calculations.kkrimporter
    :members:
+   :private-members:
+   :special-members:
 
 KKRimp
 ------
 .. automodule:: aiida_kkr.calculations.kkrimp
    :members:
+   :private-members:
+   :special-members:
diff --git a/docs/source/module_guide/parsers.rst b/docs/source/module_guide/parsers.rst
@@ -11,28 +11,37 @@ Voronoi Parser
 
 .. automodule:: aiida_kkr.parsers.voro
    :members:
+   :private-members:
+   :special-members:
 
 KKRcode Parser
 --------------
 
 .. automodule:: aiida_kkr.parsers.kkr
    :members:
+   :private-members:
+   :special-members:
 
 KKRcode - calculation importer Parser
 -------------------------------------
 
 .. automodule:: aiida_kkr.parsers.kkrimporter
    :members:
-   :special-members: __init__
+   :private-members:
+   :special-members:
 
 KKRimp Parser
 -------------
 
 .. automodule:: aiida_kkr.parsers.kkrimp
    :members:
+   :private-members:
+   :special-members:
 
 Voronoi Parser
 --------------
 
 .. automodule:: aiida_kkr.parsers.voro
    :members:
+   :private-members:
+   :special-members:
diff --git a/docs/source/module_guide/tools.rst b/docs/source/module_guide/tools.rst
@@ -5,24 +5,34 @@ Common functions that do not need aiida
 ---------------------------------------
 .. automodule:: aiida_kkr.tools.common_functions
    :members:
+   :private-members:
+   :special-members:
 
 Common (work)functions that need aiida
 --------------------------------------
 .. automodule:: aiida_kkr.tools.common_workfunctions
    :members:
+   :private-members:
+   :special-members:
 
 KKR parameters class
 --------------------
 .. automodule:: aiida_kkr.tools.kkr_params
    :members:
+   :private-members:
+   :special-members:
 
 KKR parser functions
 --------------------
 .. automodule:: aiida_kkr.tools.kkrparser_functions
    :members:
+   :private-members:
+   :special-members:
 
 Voronoi parser functions
 ------------------------
 .. automodule:: aiida_kkr.tools.voroparser_functions
    :members:
+   :private-members:
+   :special-members:
 
diff --git a/docs/source/module_guide/workflows.rst b/docs/source/module_guide/workflows.rst
@@ -10,28 +10,40 @@ Generate KKR start potential
 ----------------------------
 .. automodule:: aiida_kkr.workflows.voro_start
    :members:
+   :private-members:
+   :special-members:
 
 KKR scf cycle
 -------------
 .. automodule:: aiida_kkr.workflows.kkr_scf
    :members:
+   :private-members:
+   :special-members:
 
 Density of states
 -----------------
 .. automodule:: aiida_kkr.workflows.dos
    :members:
+   :private-members:
+   :special-members:
 
 Equation of states
 ------------------
 .. automodule:: aiida_kkr.workflows.eos
    :members:
+   :private-members:
+   :special-members:
 
 Check KKR parameter convergence
 -------------------------------
 .. automodule:: aiida_kkr.workflows.check_para_convergence
    :members:
+   :private-members:
+   :special-members:
 
 Find magnetic ground state
 --------------------------
 .. automodule:: aiida_kkr.workflows.check_magnetic_state
    :members:
+   :private-members:
+   :special-members: