Changeset 924


Ignore:
Timestamp:
Jun 13, 2012 12:42:55 PM (10 years ago)
Author:
jemian
Message:

add docstring

Location:
specdomain/src/specdomain
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • specdomain/src/specdomain/doc/starter.py

    r919 r924  
    88'''
    99
    10 import sphinx, sys
     10import os
     11import sphinx
     12import sys
     13
     14
     15def force_rebuild_all():
     16    '''
     17    Delete the *doctrees* subdirectory.
     18    '''
     19    if os.path.exists('_build/doctrees'):
     20        garbage_list = [
     21            '_build/doctrees/environment.pickle',
     22            '_build/doctrees/index.doctree',
     23            '_build/doctrees/test_doc.doctree',
     24        ]
     25        for item in garbage_list:
     26            if os.path.exists(item):
     27                os.remove(item)
     28        os.rmdir('_build/doctrees')
     29
    1130
    1231if __name__ == '__main__':
    13     args = []
    14     args.append(sys.argv[0])
    15     args = args + "-b html".split()
    16     args = args + "-d _build/doctrees .".split()
    17     args = args + "_build/html".split()
     32    force_rebuild_all()
     33    args = [sys.argv[0]] + "-b html -d _build/doctrees . _build/html".split()
    1834    sphinx.main(args)
  • specdomain/src/specdomain/test/starter.py

    r919 r924  
    1414
    1515def force_rebuild_all():
     16    '''
     17    Delete the *doctrees* subdirectory.
     18    '''
    1619    if os.path.exists('_build/doctrees'):
    1720        garbage_list = [
Note: See TracChangeset for help on using the changeset viewer.