Changeset 25427d9 in sasview for docs


Ignore:
Timestamp:
Mar 21, 2016 8:32:15 AM (9 years ago)
Author:
awashington
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
cf92b1f, 5757bbe
Parents:
1c0e3b0 (diff), bb0c836 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
Message:

Merge branch 'master' of github.com:SasView/sasview

Location:
docs/sphinx-docs
Files:
4 added
14 edited

Legend:

Unmodified
Added
Removed

  • docs/sphinx-docs/build_sphinx.py

    r756e8ce rbb0c836  
    3535#/sasview-local-trunk/docs/sphinx-docs/build_sphinx.py 
    3636SASMODELS_SOURCE_PROLOG = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc") 
    37 #SASMODELS_SOURCE_REF_MODELS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "ref", "models") 
     37SASMODELS_SOURCE_REF_MODELS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "ref", "models") 
    3838SASMODELS_SOURCE_MODELS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "model") 
    3939SASMODELS_SOURCE_IMG = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", "sasmodels", "doc", "model", "img") 
    … …  
    7171BUMPS_TARGET = os.path.join(SPHINX_SOURCE_PERSPECTIVES, "fitting") 
    7272 
     73def inplace_change(filename, old_string, new_string): 
     74# Thanks to http://stackoverflow.com/questions/4128144/replace-string-within-file-contents 
     75        s=open(filename).read() 
     76        if old_string in s: 
     77                print 'Changing "{old_string}" to "{new_string}"'.format(**locals()) 
     78                s=s.replace(old_string, new_string) 
     79                f=open(filename, 'w') 
     80                f.write(s) 
     81                f.flush() 
     82                f.close() 
     83        else: 
     84                print 'No occurences of "{old_string}" found.'.format(**locals()) 
     85 
    7386def _remove_dir(dir_path): 
    7487    """Removes the given directory.""" 
    … …  
    154167                    shutil.copy(fromhere,tohere) 
    155168 
    156     # ACTUALLY IT TURNED OUT WE NEED TO EDIT THE TOCTREES SO THIS COPY WASN'T USEFUL IN THE END! 
    157     # And the relevant rst descriptions for the new sasmodels documentation 
    158 #    if os.path.exists(SASMODELS_SOURCE_REF_MODELS): 
    159 #        print "Found docs folder SASMODELS_SOURCE_REF_MODELS at ", SASMODELS_SOURCE_REF_MODELS 
    160 #        if os.path.exists(SASMODELS_DEST_REF_MODELS): 
    161 #            print "Found docs folder SASMODELS_DEST_REF_MODELS   at ", SASMODELS_DEST_REF_MODELS 
    162 #            print "Copying sasmodels model toctree files..." 
    163 #            for files in os.listdir(SASMODELS_SOURCE_REF_MODELS): 
    164 #                if files.endswith(".rst"): 
    165 #                    fromhere=os.path.join(SASMODELS_SOURCE_REF_MODELS,files) 
    166 #                    tohere=os.path.join(SASMODELS_DEST_REF_MODELS,files) 
    167 #                    shutil.copy(fromhere,tohere) 
     169    if os.path.exists(SASMODELS_SOURCE_REF_MODELS): 
     170        print "Found docs folder SASMODELS_SOURCE_REF_MODELS at ", SASMODELS_SOURCE_REF_MODELS 
     171        if os.path.exists(SASMODELS_DEST_REF_MODELS): 
     172            print "Found docs folder SASMODELS_DEST_REF_MODELS   at ", SASMODELS_DEST_REF_MODELS 
     173            print "Copying sasmodels model toctree files..." 
     174            for files in os.listdir(SASMODELS_SOURCE_REF_MODELS): 
     175                if files.endswith(".rst"): 
     176                    fromhere=os.path.join(SASMODELS_SOURCE_REF_MODELS,files) 
     177                    tohere=os.path.join(SASMODELS_DEST_REF_MODELS,files) 
     178                    shutil.copy(fromhere,tohere) 
     179    # But need to change the path to the model docs in the tocs 
     180    for files in os.listdir(SASMODELS_DEST_REF_MODELS): 
     181#        print files 
     182        if files.startswith("shape"): 
     183            print "Changing toc paths in", files 
     184            inplace_change(os.path.join(SASMODELS_DEST_REF_MODELS,files), "../../model/", "models/") 
     185        if files.startswith("sphere"): 
     186            print "Changing toc paths in", files 
     187            inplace_change(os.path.join(SASMODELS_DEST_REF_MODELS,files), "../../model/", "models/") 
     188        if files.startswith("custom"): 
     189            print "Changing toc paths in", files 
     190            inplace_change(os.path.join(SASMODELS_DEST_REF_MODELS,files), "../../model/", "models/") 
     191        if files.startswith("structure"): 
     192            print "Changing toc paths in", files 
     193            inplace_change(os.path.join(SASMODELS_DEST_REF_MODELS,files), "../../model/", "models/") 
    168194 
    169195    if os.path.exists(SASMODELS_SOURCE_MODELS): 

  • docs/sphinx-docs/source/user/analysis.rst

    r2dd1dd3 r8f46df7  
    1 SasView Documentation: Types of Analysis 
    2 ======================================== 
     1Types of Analysis 
     2================= 
    33 
    44.. note:: In Windows use [Alt]-[Cursor left] to return to the previous page 

  • docs/sphinx-docs/source/user/custom-models.rst

    r333575b rf1a28b4  
     1.. 
     2    Generated from doc/gentoc.py -- DO NOT EDIT -- 
     3 
    14.. Custom-models: 
    25 

  • docs/sphinx-docs/source/user/index.rst

    r333575b rf1a28b4  
     1.. 
     2    Generated from doc/gentoc.py -- DO NOT EDIT -- 
     3 
    14.. Models: 
    25 
    … …  
    1316    shape-parallelepiped.rst 
    1417    shape-sphere.rst 
     18    sphere-based.rst 
    1519    shape-independent.rst 
    1620    structure-factor.rst 

  • docs/sphinx-docs/source/user/shape-cylinder.rst

    r333575b rf1a28b4  
     1.. 
     2    Generated from doc/gentoc.py -- DO NOT EDIT -- 
     3 
    14.. shape-cylinder: 
    25 
    … …  
    1417    models/elliptical_cylinder.rst 
    1518    models/flexible_cylinder.rst 
    16     models/flexible_cylinder_ex.rst 
     19    models/flexible_cylinder_elliptical.rst 
    1720    models/hollow_cylinder.rst 
    1821    models/pearl_necklace.rst 
     22    models/pringle.rst 
    1923    models/stacked_disks.rst 

  • docs/sphinx-docs/source/user/shape-ellipsoid.rst

    r333575b rf1a28b4  
     1.. 
     2    Generated from doc/gentoc.py -- DO NOT EDIT -- 
     3 
    14.. shape-ellipsoid: 
    25 

  • docs/sphinx-docs/source/user/shape-independent.rst

    r333575b rf1a28b4  
     1.. 
     2    Generated from doc/gentoc.py -- DO NOT EDIT -- 
     3 
    14.. Shape-independent: 
    25 
    … …  
    1114    models/correlation_length.rst 
    1215    models/dab.rst 
     16    models/fractal.rst 
    1317    models/fractal_core_shell.rst 
    1418    models/gauss_lorentz_gel.rst 
    … …  
    2125    models/mass_fractal.rst 
    2226    models/mass_surface_fractal.rst 
    23     models/micelle_spherical_core.rst 
    2427    models/mono_gauss_coil.rst 
    2528    models/peak_lorentz.rst 

  • docs/sphinx-docs/source/user/shape-lamellae.rst

    r76d905f rf1a28b4  
     1.. 
     2    Generated from doc/gentoc.py -- DO NOT EDIT -- 
     3 
    14.. shape-lamellae: 
    25 
    … …  
    710.. toctree:: 
    811 
    9     models//lamellar.rst 
    10     models//lamellar_hg.rst 
    11     models//lamellar_hg_stack_caille.rst 
    12     models//lamellar_stack_caille.rst 
    13     models//lamellar_stack_paracrystal.rst 
    14      
     12    models/lamellar.rst 
     13    models/lamellar_hg.rst 
     14    models/lamellar_hg_stack_caille.rst 
     15    models/lamellar_stack_caille.rst 
     16    models/lamellar_stack_paracrystal.rst 

  • docs/sphinx-docs/source/user/shape-paracrystal.rst

    r333575b rf1a28b4  
     1.. 
     2    Generated from doc/gentoc.py -- DO NOT EDIT -- 
     3 
    14.. shape-paracrystal: 
    25 

  • docs/sphinx-docs/source/user/shape-parallelepiped.rst

    r333575b rf1a28b4  
     1.. 
     2    Generated from doc/gentoc.py -- DO NOT EDIT -- 
     3 
    14.. shape-parallelepiped: 
    25 

  • docs/sphinx-docs/source/user/shape-sphere.rst

    r333575b rf1a28b4  
     1.. 
     2    Generated from doc/gentoc.py -- DO NOT EDIT -- 
     3 
    14.. shape-sphere: 
    25 
    … …  
    811 
    912    models/adsorbed_layer.rst 
     13    models/binary_hard_sphere.rst 
    1014    models/core_shell_sphere.rst 
    1115    models/fuzzy_sphere.rst 
    1216    models/linear_pearls.rst 
    1317    models/multi_shell.rst 
     18    models/onion.rst 
     19    models/polymer_micelle.rst 
     20    models/raspberry.rst 
    1421    models/sphere.rst 
    1522    models/spherepy.rst 

  • docs/sphinx-docs/source/user/structure-factor.rst

    r333575b rf1a28b4  
     1.. 
     2    Generated from doc/gentoc.py -- DO NOT EDIT -- 
     3 
    14.. Structure-factor: 
    25 

  • docs/sphinx-docs/source/user/tools.rst

    r2dd1dd3 r8f46df7  
    1 SasView Documentation: Tools 
    2 ============================ 
     1Tools 
     2===== 
    33 
    44.. note:: In Windows use [Alt]-[Cursor left] to return to the previous page 

  • docs/sphinx-docs/source/user/user.rst

    ra407a40 r8f46df7  
    77   :maxdepth: 1 
    88 
    9    Old SasView Model Documentation <models/olddocs/model_functions> 
     9   SasView (4.x.x) Model Documentation <index> 
     10 
     11   SasView (3.x.x) Model Documentation <models/olddocs/model_functions> 
    1012    
    11    New SasModels Model Documentation <index> 
     13   Analysis <analysis> 
    1214    
    1315   Tools <tools> 
    14     
    15    Types of Analysis <analysis> 
    16  
    17    Data Formats <sasgui/guiframe/data_formats_help> 
    18     
    19    Loading Data <sasgui/guiframe/data_explorer_help> 
    20     
    21    Plotting Data/Models <sasgui/guiframe/graph_help> 
    22        
    23    Test Data <../test/testdata_help.rst> 
     16          
     17   Working with SasView <working> 
Note: See TracChangeset for help on using the changeset viewer.