From d8f00a2f3b8e3c1756be15658082bd3e18eb39c1 Mon Sep 17 00:00:00 2001 From: Gideon Date: Sun, 23 Jun 2019 16:09:16 +0200 Subject: [PATCH] debug commit. --- conf.py | 16 +++++++++++++++- core/python/spirit/chain.py | 2 +- core/python/spirit/configuration.py | 2 +- core/python/spirit/constants.py | 2 +- core/python/spirit/geometry.py | 2 +- core/python/spirit/hamiltonian.py | 2 +- core/python/spirit/htst.py | 2 +- core/python/spirit/io.py | 2 +- core/python/spirit/log.py | 2 +- core/python/spirit/quantities.py | 2 +- core/python/spirit/simulation.py | 2 +- core/python/spirit/state.py | 2 +- core/python/spirit/system.py | 2 +- core/python/spirit/transition.py | 2 +- 14 files changed, 28 insertions(+), 14 deletions(-) diff --git a/conf.py b/conf.py index b3e932c97..ce941a486 100644 --- a/conf.py +++ b/conf.py @@ -129,7 +129,9 @@ # further. For a list of options available for each theme, see the # documentation. # -# html_theme_options = {} +html_theme_options = { + "collapse_navigation" : False +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -264,6 +266,18 @@ def run_apidoc(_): with open(os.path.join(apidoc_dir, 'spirit.parameters.mmf.rst'), 'r') as generated_file: parameters_file.write(generated_file.read()) + print("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx") + print("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx") + testfile = os.path.join(apidoc_dir, 'spirit.log.rst') + with open(testfile, 'r') as f: + print(f.read()) + print("yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy") + print("yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy") + testfile = os.path.join(apidoc_dir, 'spirit.geometry.rst') + with open(testfile, 'r') as f: + print(f.read()) + print("zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz") + print("zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz") if not os.path.exists(apidoc_dir): os.mkdir(apidoc_dir) diff --git a/core/python/spirit/chain.py b/core/python/spirit/chain.py index 16bbe6af5..c42c35468 100644 --- a/core/python/spirit/chain.py +++ b/core/python/spirit/chain.py @@ -1,6 +1,6 @@ """ Chain --------------------- +==================== Manipulate the chain of spin systems (also called images), e.g. add, remove or change active image. Get information, such as number of images or energies and reaction coordinates. diff --git a/core/python/spirit/configuration.py b/core/python/spirit/configuration.py index 2a2d77179..ca8166162 100644 --- a/core/python/spirit/configuration.py +++ b/core/python/spirit/configuration.py @@ -1,6 +1,6 @@ """ Configuration --------------------- +==================== Set various spin configurations, such as homogeneous domains, spirals or skyrmions. """ diff --git a/core/python/spirit/constants.py b/core/python/spirit/constants.py index 1862e9a7b..203710c0f 100644 --- a/core/python/spirit/constants.py +++ b/core/python/spirit/constants.py @@ -1,6 +1,6 @@ """ Constants --------------------- +==================== """ import spirit.spiritlib as spiritlib diff --git a/core/python/spirit/geometry.py b/core/python/spirit/geometry.py index 9cb2da757..a917be4ac 100644 --- a/core/python/spirit/geometry.py +++ b/core/python/spirit/geometry.py @@ -1,6 +1,6 @@ """ Geometry --------------------- +==================== Change or get info on the current geometrical configuration, e.g. number of cells in the three crystal translation directions. diff --git a/core/python/spirit/hamiltonian.py b/core/python/spirit/hamiltonian.py index b7d116a76..0a42def44 100644 --- a/core/python/spirit/hamiltonian.py +++ b/core/python/spirit/hamiltonian.py @@ -1,6 +1,6 @@ """ Hamiltonian --------------------- +==================== Set the parameters of the Heisenberg Hamiltonian, such as external field or exchange interaction. """ diff --git a/core/python/spirit/htst.py b/core/python/spirit/htst.py index 2459734d0..9a972178b 100644 --- a/core/python/spirit/htst.py +++ b/core/python/spirit/htst.py @@ -1,6 +1,6 @@ """ HTST --------------------- +==================== Harmonic transition state theory. diff --git a/core/python/spirit/io.py b/core/python/spirit/io.py index 811f867b2..af7c350a5 100644 --- a/core/python/spirit/io.py +++ b/core/python/spirit/io.py @@ -1,6 +1,6 @@ """ I/O --------------------- +==================== Read and write spin configurations, chains or eigenmodes. Vectorfields are generally written in the `OOMMF vector field (OVF) file format `_. diff --git a/core/python/spirit/log.py b/core/python/spirit/log.py index 6e02d5add..d03517869 100644 --- a/core/python/spirit/log.py +++ b/core/python/spirit/log.py @@ -1,6 +1,6 @@ """ Log --------------------- +==================== """ import spirit.spiritlib as spiritlib diff --git a/core/python/spirit/quantities.py b/core/python/spirit/quantities.py index c7598d81d..dd2ea2c98 100644 --- a/core/python/spirit/quantities.py +++ b/core/python/spirit/quantities.py @@ -1,6 +1,6 @@ """ Quantities --------------------- +==================== """ import spirit.spiritlib as spiritlib diff --git a/core/python/spirit/simulation.py b/core/python/spirit/simulation.py index a356e2247..8bd71dce0 100644 --- a/core/python/spirit/simulation.py +++ b/core/python/spirit/simulation.py @@ -1,6 +1,6 @@ """ Simulation --------------------- +==================== This module of Spirit is used to run and monitor iterative calculation methods. diff --git a/core/python/spirit/state.py b/core/python/spirit/state.py index 23fb7186b..3cd4f4c0d 100644 --- a/core/python/spirit/state.py +++ b/core/python/spirit/state.py @@ -1,6 +1,6 @@ """ State --------------------- +==================== The state contains the chain of spin systems (also called images). diff --git a/core/python/spirit/system.py b/core/python/spirit/system.py index d5384c81f..7333d96f5 100644 --- a/core/python/spirit/system.py +++ b/core/python/spirit/system.py @@ -1,6 +1,6 @@ """ System --------------------- +==================== """ import spirit.spiritlib as spiritlib diff --git a/core/python/spirit/transition.py b/core/python/spirit/transition.py index 954c5ee4a..5d3d21aef 100644 --- a/core/python/spirit/transition.py +++ b/core/python/spirit/transition.py @@ -1,6 +1,6 @@ """ Transition --------------------- +==================== """ import spirit.spiritlib as spiritlib