Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed

  • docs/sphinx-docs/build_sphinx.py

    r01f1e17 r751f4bd  
    66http://sphinx-doc.org/invocation.html 
    77""" 
    8 from __future__ import print_function 
    9  
    108import subprocess 
    119import os 
    … …  
    1412import shutil 
    1513import imp 
    16  
    1714from glob import glob 
     15 
    1816from distutils.dir_util import copy_tree 
    1917from distutils.util import get_platform 
    … …  
    5755SASMODELS_DEST_BUILDIMG = os.path.join(SASMODELS_DEST_PROLOG, "user", "models", "img") 
    5856 
     57#if os.path.exists(SASMODELS_SOURCE_PROLOG): 
     58#    print "Found models prolog folder at ", SASMODELS_SOURCE_PROLOG 
     59#if os.path.exists(SASMODELS_SOURCE_REF_MODELS): 
     60#    print "Found models ref folder at ", SASMODELS_SOURCE_REF_MODELS 
     61#if os.path.exists(SASMODELS_SOURCE_MODELS): 
     62#    print "Found models folder at ", SASMODELS_SOURCE_MODELS 
     63#if os.path.exists(SASMODELS_SOURCE_IMG): 
     64#    print "Found img folder at ", SASMODELS_SOURCE_IMG 
     65#if os.path.exists(SASMODELS_DEST_REF_MODELS): 
     66#    print "Found models ref folder at ", SASMODELS_DEST_REF_MODELS 
     67#if os.path.exists(SASMODELS_DEST_MODELS): 
     68#    print "Found models folder at ", SASMODELS_DEST_MODELS 
     69#if os.path.exists(SASMODELS_DEST_IMG): 
     70#    print "Found img folder at ", SASMODELS_DEST_IMG 
     71#sys.exit() 
    5972 
    6073SPHINX_BUILD = os.path.join(CURRENT_SCRIPT_DIR, "build") 
    … …  
    7588        s=open(filename).read() 
    7689        if old_string in s: 
    77                 print('Changing "{old_string}" to "{new_string}"'.format(**locals())) 
     90                print 'Changing "{old_string}" to "{new_string}"'.format(**locals()) 
    7891                s=s.replace(old_string, new_string) 
    7992                f=open(filename, 'w') 
    … …  
    8295                f.close() 
    8396        else: 
    84                 print('No occurences of "{old_string}" found.'.format(**locals())) 
     97                print 'No occurences of "{old_string}" found.'.format(**locals()) 
    8598 
    8699def _remove_dir(dir_path): 
    87100    """Removes the given directory.""" 
    88101    if os.path.isdir(dir_path): 
    89         print("Removing \"%s\"... " % dir_path) 
     102        print "Removing \"%s\"... " % dir_path 
    90103        shutil.rmtree(dir_path) 
    91104 
    … …  
    94107    Clean the sphinx build directory. 
    95108    """ 
    96     print("=== Cleaning Sphinx Build ===") 
     109    print "=== Cleaning Sphinx Build ===" 
    97110    _remove_dir(SASVIEW_DOCS) 
    98111    _remove_dir(SPHINX_BUILD) 
    … …  
    107120    Copy the source toctrees to new folder for assembling the sphinx-docs 
    108121    """ 
    109     print("=== Copying Source toctrees ===") 
     122    print "=== Copying Source toctrees ===" 
    110123    if os.path.exists(SASVIEW_TOC_SOURCE): 
    111        print("Found docs folder at", SASVIEW_TOC_SOURCE) 
     124       print "Found docs folder at ", SASVIEW_TOC_SOURCE 
    112125       shutil.copytree(SASVIEW_TOC_SOURCE, SPHINX_SOURCE) 
    113126 
    … …  
    128141    so that Sphinx may pick it up when generating the documentation. 
    129142    """ 
    130     print("=== Retrieve User Docs ===") 
     143    print "=== Retrieve User Docs ===" 
    131144 
    132145    # Copy documentation files from their "source" to their "destination". 
    … …  
    135148 
    136149            docs = os.path.abspath(os.path.join(root, dirname)) 
    137             print("Found docs folder at \"%s\"." % docs) 
     150            print "Found docs folder at \"%s\"." % docs 
    138151 
    139152            dest_dir_part = os.path.dirname(os.path.relpath(docs, SASVIEW_SRC)) 
    … …  
    145158 
    146159    # Now pickup testdata_help.rst 
    147     print("=== Including Test Data Docs ===") 
     160#    print os.path.abspath(SASVIEW_TEST) 
     161#    print os.path.abspath(SPHINX_SOURCE_TEST) 
     162    print "=== Including Test Data Docs ===" 
    148163    if os.path.exists(SASVIEW_TEST): 
    149        print("Found docs folder at", SASVIEW_TEST) 
     164       print "Found docs folder at ", SASVIEW_TEST 
    150165       shutil.copytree(SASVIEW_TEST, SPHINX_SOURCE_TEST) 
    151166 
    152     print("=== And the Sasmodels Docs ===") 
     167    print "=== And the Sasmodels Docs ===" 
    153168    # Make sure we have the relevant images for the new sasmodels documentation 
    154169    # First(!) we'll make a local reference copy for SasView (/new-models will be cleaned each build) 
    155170    if os.path.exists(SASMODELS_SOURCE_IMG): 
    156         print("Found img folder SASMODELS_SOURCE_IMG at", SASMODELS_SOURCE_IMG) 
     171        print "Found img  folder SASMODELS_SOURCE_IMG    at ", SASMODELS_SOURCE_IMG 
    157172        if not os.path.exists(SASMODELS_DEST_IMG): 
    158             print("Missing docs folder SASMODELS_DEST_IMG at", SASMODELS_DEST_IMG) 
     173            print "Missing docs folder SASMODELS_DEST_IMG at ", SASMODELS_DEST_IMG 
    159174            os.makedirs(SASMODELS_DEST_IMG) 
    160             print("created SASMODELS_DEST_BUILDIMG at", SASMODELS_DEST_BUILDIMG) 
    161         else: 
    162             print("Found img folder SASMODELS_DEST_IMG at", SASMODELS_DEST_IMG) 
    163         print("Copying sasmodels model image files...") 
     175            print "created SASMODELS_DEST_BUILDIMG at ", SASMODELS_DEST_BUILDIMG 
     176        else: print "Found img  folder SASMODELS_DEST_IMG      at ", SASMODELS_DEST_IMG 
     177        print "Copying sasmodels model image files..." 
    164178        for files in os.listdir(SASMODELS_SOURCE_IMG): 
    165179            fromhere=os.path.join(SASMODELS_SOURCE_IMG,files) 
    166180            tohere=os.path.join(SASMODELS_DEST_IMG,files) 
    167181            shutil.copy(fromhere,tohere) 
    168     else: 
    169         print("no source directory",SASMODELS_SOURCE_IMG,"was found") 
     182    else: print "cannot find SASMODELS_SOURCE_IMG", SASMODELS_SOURCE_IMG 
    170183 
    171184    if os.path.exists(SASMODELS_SOURCE_AUTOIMG): 
    172         print("Found img folder SASMODELS_SOURCE_AUTOIMG at", SASMODELS_SOURCE_AUTOIMG) 
     185        print "Found img  folder SASMODELS_SOURCE_AUTOIMG    at ", SASMODELS_SOURCE_AUTOIMG 
    173186        if not os.path.exists(SASMODELS_DEST_IMG): 
    174             print("Missing docs folder SASMODELS_DEST_IMG at", SASMODELS_DEST_IMG) 
     187            print "Missing docs folder SASMODELS_DEST_IMG at ", SASMODELS_DEST_IMG 
    175188            os.makedirs(SASMODELS_DEST_BUILDIMG) 
    176             print("created SASMODELS_DEST_BUILDIMG at", SASMODELS_DEST_BUILDIMG) 
    177         print("Copying sasmodels model auto-generated image files...") 
     189            print "created SASMODELS_DEST_BUILDIMG at ", SASMODELS_DEST_BUILDIMG 
     190        print "Copying sasmodels model auto-generated image files..." 
    178191        for files in os.listdir(SASMODELS_SOURCE_AUTOIMG): 
    179192            fromhere=os.path.join(SASMODELS_SOURCE_AUTOIMG,files) 
    180193            tohere=os.path.join(SASMODELS_DEST_IMG,files) 
    181194            shutil.copy(fromhere,tohere) 
    182     else: 
    183         print("no source directory",SASMODELS_SOURCE_AUTOIMG ,"was found") 
     195    else: print "no source directory",SASMODELS_SOURCE_AUTOIMG ,"was found" 
    184196 
    185197    # And the rst prolog with the unit substitutions 
    186198    if os.path.exists(SASMODELS_SOURCE_PROLOG): 
    187         print("Found prolog folder SASMODELS_SOURCE_PROLOG at", SASMODELS_SOURCE_PROLOG) 
     199        print "Found prolog folder SASMODELS_SOURCE_PROLOG at ", SASMODELS_SOURCE_PROLOG 
    188200        if os.path.exists(SASMODELS_DEST_PROLOG): 
    189             print("Found docs folder SASMODELS_DEST_PROLOG at", SASMODELS_DEST_PROLOG) 
    190             print("Copying sasmodels rst_prolog file...") 
     201            print "Found docs folder SASMODELS_DEST_PROLOG   at ", SASMODELS_DEST_PROLOG 
     202            print "Copying sasmodels rst_prolog file..." 
    191203            for files in os.listdir(SASMODELS_SOURCE_PROLOG): 
    192204                if files.startswith("rst"): 
    … …  
    194206                    tohere=os.path.join(SASMODELS_DEST_PROLOG,files) 
    195207                    shutil.copy(fromhere,tohere) 
    196     else: 
    197         print("no source directory",SASMODELS_SOURCE_PROLOG, "was found") 
    198208 
    199209    if os.path.exists(SASMODELS_SOURCE_GPU): 
    200         print("Found docs folder SASMODELS_SOURCE_GPU at", SASMODELS_SOURCE_GPU) 
     210        print "Found docs folder SASMODELS_SOURCE_GPU at ", SASMODELS_SOURCE_GPU 
    201211        if os.path.exists(SPHINX_SOURCE_USER): 
    202             print("Found docs folder SPHINX_SOURCE_USER at", SPHINX_SOURCE_USER) 
    203             print("Copying sasmodels gpu files...") 
     212            print "Found docs folder SPHINX_SOURCE_USER      at ", SPHINX_SOURCE_USER 
     213            print "Copying sasmodels gpu files..." 
    204214            for files in os.listdir(SASMODELS_SOURCE_GPU): 
    205215                if files.endswith(".rst"): 
    … …  
    207217                    tohere=os.path.join(SPHINX_SOURCE_USER,files) 
    208218                    shutil.copy(fromhere,tohere) 
    209     else: 
    210         print("no source directory",SASMODELS_SOURCE_GPU,"was found") 
    211219 
    212220    if os.path.exists(SASMODELS_SOURCE_SESANS): 
    213         print("Found docs folder SASMODELS_SOURCE_SESANS at", SASMODELS_SOURCE_SESANS) 
     221        print "Found docs folder SASMODELS_SOURCE_SESANS at ", SASMODELS_SOURCE_SESANS 
    214222        if os.path.exists(SPHINX_SOURCE_USER): 
    215             print("Found docs folder SPHINX_SOURCE_USER at", SPHINX_SOURCE_USER) 
    216             print("Copying sasmodels sesans files...") 
     223            print "Found docs folder SPHINX_SOURCE_USER      at ", SPHINX_SOURCE_USER 
     224            print "Copying sasmodels sesans files..." 
    217225            for files in os.listdir(SASMODELS_SOURCE_SESANS): 
    218226                if files.endswith(".rst"): 
    … …  
    220228                    tohere=os.path.join(SPHINX_SOURCE_USER,files) 
    221229                    shutil.copy(fromhere,tohere) 
    222     else: 
    223         print("no source directory",SASMODELS_SOURCE_SESANS,"was found") 
    224230 
    225231    if os.path.exists(SASMODELS_SOURCE_MAGNETISM): 
    226         print("Found docs folder SASMODELS_SOURCE_MAGNETISM at", SASMODELS_SOURCE_MAGNETISM) 
     232        print "Found docs folder SASMODELS_SOURCE_MAGNETISM at ", SASMODELS_SOURCE_MAGNETISM 
    227233        if os.path.exists(SASMODELS_DEST_REF_MODELS): 
    228             print("Found docs folder SASMODELS_DEST_REF_MODELS at", SASMODELS_DEST_REF_MODELS) 
    229             print("Copying sasmodels model toctree files...") 
     234            print "Found docs folder SASMODELS_DEST_REF_MODELS   at ", SASMODELS_DEST_REF_MODELS 
     235            print "Copying sasmodels model toctree files..." 
    230236            for files in os.listdir(SASMODELS_SOURCE_MAGNETISM): 
    231237                if files.endswith(".rst"): 
    … …  
    233239                    tohere=os.path.join(SASMODELS_DEST_REF_MODELS,files) 
    234240                    shutil.copy(fromhere,tohere) 
    235     else: 
    236         print("no source directory",SASMODELS_SOURCE_MAGNETISM,"was found") 
    237241 
    238242    if os.path.exists(SASMODELS_SOURCE_MAGIMG): 
    239         print("Found img folder SASMODELS_SOURCE_MAGIMG   at", SASMODELS_SOURCE_MAGIMG) 
     243        print "Found img folder SASMODELS_SOURCE_MAGIMG   at ", SASMODELS_SOURCE_MAGIMG 
    240244        if not os.path.exists(SASMODELS_DEST_MAGIMG): 
    241             print("Missing img folder SASMODELS_DEST_MAGIMG at", SASMODELS_DEST_MAGIMG) 
     245            print "Missing img folder SASMODELS_DEST_MAGIMG at ", SASMODELS_DEST_MAGIMG 
    242246            os.makedirs(SASMODELS_DEST_MAGIMG) 
    243             print("created SASMODELS_DEST_MAGIMG at", SASMODELS_DEST_MAGIMG) 
    244         print("Copying sasmodels mag image files...") 
     247            print "created SASMODELS_DEST_MAGIMG at ", SASMODELS_DEST_MAGIMG 
     248        print "Copying sasmodels mag image files..." 
    245249        for files in os.listdir(SASMODELS_SOURCE_MAGIMG): 
    246250            fromhere=os.path.join(SASMODELS_SOURCE_MAGIMG,files) 
    247251            tohere=os.path.join(SASMODELS_DEST_MAGIMG,files) 
    248252            shutil.copy(fromhere,tohere) 
    249     else: 
    250         print("no source directory",SASMODELS_SOURCE_MAGIMG ,"was found") 
     253    else: print "no source directory",SASMODELS_SOURCE_MAGIMG ,"was found" 
    251254 
    252255    if os.path.exists(SASMODELS_SOURCE_SESANSIMG): 
    253         print("Found img folder SASMODELS_SOURCE_SESANSIMG at", SASMODELS_SOURCE_SESANSIMG) 
     256        print "Found img folder SASMODELS_SOURCE_SESANSIMG   at ", SASMODELS_SOURCE_SESANSIMG 
    254257        if not os.path.exists(SASMODELS_DEST_SESANSIMG): 
    255             print("Missing img folder SASMODELS_DEST_SESANSIMG at", SASMODELS_DEST_SESANSIMG) 
     258            print "Missing img folder SASMODELS_DEST_SESANSIMG at ", SASMODELS_DEST_SESANSIMG 
    256259            os.makedirs(SASMODELS_DEST_SESANSIMG) 
    257             print("created SASMODELS_DEST_SESANSIMG at", SASMODELS_DEST_SESANSIMG) 
    258         print("Copying sasmodels sesans image files...") 
     260            print "created SASMODELS_DEST_SESANSIMG at ", SASMODELS_DEST_SESANSIMG 
     261        print "Copying sasmodels sesans image files..." 
    259262        for files in os.listdir(SASMODELS_SOURCE_SESANSIMG): 
    260263            fromhere=os.path.join(SASMODELS_SOURCE_SESANSIMG,files) 
    261264            tohere=os.path.join(SASMODELS_DEST_SESANSIMG,files) 
    262265            shutil.copy(fromhere,tohere) 
    263     else: 
    264         print("no source directory",SASMODELS_SOURCE_SESANSIMG ,"was found") 
     266    else: print "no source directory",SASMODELS_SOURCE_SESANSIMG ,"was found" 
    265267 
    266268    if os.path.exists(SASMODELS_SOURCE_REF_MODELS): 
    267         print("Found docs folder SASMODELS_SOURCE_REF_MODELS at", SASMODELS_SOURCE_REF_MODELS) 
     269        print "Found docs folder SASMODELS_SOURCE_REF_MODELS at ", SASMODELS_SOURCE_REF_MODELS 
    268270        if os.path.exists(SASMODELS_DEST_REF_MODELS): 
    269             print("Found docs folder SASMODELS_DEST_REF_MODELS at", SASMODELS_DEST_REF_MODELS) 
    270             print("Copying sasmodels model toctree files...") 
     271            print "Found docs folder SASMODELS_DEST_REF_MODELS   at ", SASMODELS_DEST_REF_MODELS 
     272            print "Copying sasmodels model toctree files..." 
    271273            for files in os.listdir(SASMODELS_SOURCE_REF_MODELS): 
    272274                if files.endswith(".rst"): 
    … …  
    274276                    tohere=os.path.join(SASMODELS_DEST_REF_MODELS,files) 
    275277                    shutil.copy(fromhere,tohere) 
    276             # But need to change the path to the model docs in the tocs 
    277             for files in os.listdir(SASMODELS_DEST_REF_MODELS): 
    278         #        print files 
    279                 if files.startswith("shape"): 
    280                     print("Changing toc paths in", files) 
    281                     inplace_change(os.path.join(SASMODELS_DEST_REF_MODELS,files), "../../model/", "models/") 
    282                 if files.startswith("sphere"): 
    283                     print("Changing toc paths in", files) 
    284                     inplace_change(os.path.join(SASMODELS_DEST_REF_MODELS,files), "../../model/", "models/") 
    285                 if files.startswith("custom"): 
    286                     print("Changing toc paths in", files) 
    287                     inplace_change(os.path.join(SASMODELS_DEST_REF_MODELS,files), "../../model/", "models/") 
    288                 if files.startswith("structure"): 
    289                     print("Changing toc paths in", files) 
    290                     inplace_change(os.path.join(SASMODELS_DEST_REF_MODELS,files), "../../model/", "models/") 
    291     else: 
    292         print("no source directory",SASMODELS_SOURCE_REF_MODELS," was found") 
     278    # But need to change the path to the model docs in the tocs 
     279    for files in os.listdir(SASMODELS_DEST_REF_MODELS): 
     280#        print files 
     281        if files.startswith("shape"): 
     282            print "Changing toc paths in", files 
     283            inplace_change(os.path.join(SASMODELS_DEST_REF_MODELS,files), "../../model/", "models/") 
     284        if files.startswith("sphere"): 
     285            print "Changing toc paths in", files 
     286            inplace_change(os.path.join(SASMODELS_DEST_REF_MODELS,files), "../../model/", "models/") 
     287        if files.startswith("custom"): 
     288            print "Changing toc paths in", files 
     289            inplace_change(os.path.join(SASMODELS_DEST_REF_MODELS,files), "../../model/", "models/") 
     290        if files.startswith("structure"): 
     291            print "Changing toc paths in", files 
     292            inplace_change(os.path.join(SASMODELS_DEST_REF_MODELS,files), "../../model/", "models/") 
    293293 
    294294    if os.path.exists(SASMODELS_SOURCE_MODELS): 
    295         print("Found docs folder SASMODELS_SOURCE_MODELS at", SASMODELS_SOURCE_MODELS) 
     295        print "Found docs folder SASMODELS_SOURCE_MODELS at ", SASMODELS_SOURCE_MODELS 
    296296        if os.path.exists(SASMODELS_DEST_MODELS): 
    297             print("Found docs folder SASMODELS_DEST_MODELS at", SASMODELS_DEST_MODELS) 
    298             print("Copying sasmodels model files...") 
     297            print "Found docs folder SASMODELS_DEST_MODELS   at ", SASMODELS_DEST_MODELS 
     298            print "Copying sasmodels model files..." 
    299299            for files in os.listdir(SASMODELS_SOURCE_MODELS): 
    300300                if files.endswith(".rst"): 
    … …  
    303303                    shutil.copy(fromhere,tohere) 
    304304        else: 
    305             print("Missing docs folder SASMODELS_DEST_MODELS at", SASMODELS_DEST_MODELS) 
     305            print "Missing docs folder SASMODELS_DEST_MODELS at ", SASMODELS_DEST_MODELS 
    306306            os.makedirs(SASMODELS_DEST_MODELS) 
    307307            if not os.path.exists(SASMODELS_DEST_BUILDIMG): 
    308308                os.makedirs(SASMODELS_DEST_BUILDIMG) 
    309             print("Created docs folder SASMODELS_DEST_MODELS at", SASMODELS_DEST_MODELS) 
    310             print("Copying model files for build...") 
     309            print "Created docs folder SASMODELS_DEST_MODELS at ", SASMODELS_DEST_MODELS 
     310            print "Copying model files for build..." 
    311311            for files in os.listdir(SASMODELS_SOURCE_MODELS): 
    312312                if files.endswith(".rst"): 
    … …  
    315315                    shutil.copy(fromhere,tohere) 
    316316            # No choice but to do this because model files are all coded for images in /models/img 
    317             print("Copying image files for build...") 
     317            print "Copying image files for build..." 
    318318            for files in os.listdir(SASMODELS_DEST_IMG): 
    319319                fromhere=os.path.join(SASMODELS_DEST_IMG,files) 
    320320                tohere=os.path.join(SASMODELS_DEST_BUILDIMG,files) 
    321321                shutil.copy(fromhere,tohere) 
    322     else: 
    323         print("no source directory",SASMODELS_SOURCE_MODELS,"was found.") 
    324         print("!!!!NO MODEL DOCS WILL BE BUILT!!!!") 
    325322 
    326323 
    … …  
    330327    """ 
    331328    if os.path.exists(BUMPS_DOCS): 
    332         print("=== Retrieve BUMPS Docs ===") 
     329        print "=== Retrieve BUMPS Docs ===" 
    333330        filenames = [os.path.join(BUMPS_DOCS, "optimizer.rst")] 
    334331        filenames += glob(os.path.join(BUMPS_DOCS, "dream-*.png")) 
    335332        filenames += glob(os.path.join(BUMPS_DOCS, "fit-*.png")) 
    336333        for f in filenames: 
    337             print("Copying file", f) 
     334            print "Copying file", f 
    338335            shutil.copy(f, BUMPS_TARGET) 
    339336    else: 
    340         print(""" 
    341 ======= Error ======= 
    342 missing directory %s 
     337        print """ 
     338*** Error *** missing directory %s 
    343339The documentation will not include the optimizer selection section. 
    344340Checkout the bumps source tree and rebuild the docs. 
    345 """ % BUMPS_DOCS) 
     341 
     342 
     343""" % BUMPS_DOCS 
    346344 
    347345def apidoc(): 
    … …  
    350348    in the SasView build directory. 
    351349    """ 
    352     print("=== Generate API Rest Files ===") 
     350    print "=== Generate API Rest Files ===" 
    353351 
    354352    # Clean directory before generating a new version. 
    … …  
    364362    Runs sphinx-build.  Reads in all .rst files and spits out the final html. 
    365363    """ 
    366     print("=== Build HTML Docs from Rest Files ===") 
     364    print "=== Build HTML Docs from Rest Files ===" 
    367365    subprocess.call(["sphinx-build", 
    368366                     "-b", "html", # Builder name. TODO: accept as arg to setup.py. 
    … …  
    371369                     os.path.join(SPHINX_BUILD, "html")]) 
    372370 
    373     print("=== Copy HTML Docs to Build Directory ===") 
     371    print "=== Copy HTML Docs to Build Directory ===" 
    374372    html = os.path.join(SPHINX_BUILD, "html") 
    375373    copy_tree(html, SASVIEW_DOCS) 
    … …  
    383381    build() 
    384382 
    385     print("=== Done ===") 
     383    print "=== Done ===" 
    386384 
    387385if __name__ == "__main__": 
Note: See TracChangeset for help on using the changeset viewer.