Update manual

GrupEstructuraElectronicaSimetria · Dec 21, 2020 · 9aa1d3f · 9aa1d3f
1 parent 75e76e6
commit 9aa1d3f
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 7 deletions.
diff --git a/cosymlib/__init__.py b/cosymlib/__init__.py
@@ -147,9 +147,9 @@ def print_shape_structure(self, shape_reference, central_atom=0, fix_permutation
         Method that prints to file shape's structure
 
         :param shape_reference: reference polyhedra label which user will compare with his polyhedra.
-                                Reference labels can be found in [#f1]_
         :param central_atom: position of the central atom in molecule if exist
-        :param output_name: custom name without extension
+        :param fix_permutation: True or False
+        :param output: custom name without extension
         :return: shape's structure in the output_name.out file
         """
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -82,7 +82,7 @@
 todo_include_todos = False
 
 
-autodoc_mock_imports = ['cosymlib.molecule', 'wfnsympy', 'symgroupy']
+autodoc_mock_imports = ['cosymlib.molecule', 'shp', 'wfnsympy', 'symgroupy']
 
 # -- Options for HTML output ----------------------------------------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -10,8 +10,6 @@
 cosymlib
 ########
 
--------------
-
 **Cosymlib** is a python library for computing continuous symmetry & shape measures (CSMs & CShMs).
 Although its main aim is to provide simple and ready-to-use tools for the analysis of the symmetry &
 shape of molecules, many of the procedures contained in **cosymlib** can be easily applied to
@@ -62,5 +60,3 @@ and the Institut de Química Teòrica i Computacional (IQTCUB). University of Ba
 .. image:: images/logo_mmaeztu.png
     :height: 52px
     :align: left
-
-