Changeset 937

Timestamp:

Jun 15, 2012 6:06:40 PM (11 years ago)

Author:

jemian

Message:

refs #8, document the commands, as they exist now

Location:

specdomain/src/specdomain

Files:

• doc/index.rst (modified) (1 diff)
• doc/spec.rst (added)
• doc/starter.py (modified) (1 diff)
• sphinxcontrib/specdomain.py (modified) (2 diffs)
• test/starter.py (modified) (1 diff)

specdomain/src/specdomain/doc/index.rst

@@ -12 +12 @@
 
    objectives
+   spec
+
+Other matters:
+
+.. toctree::
+   :maxdepth: 2
+
    reference
    changes
    license
+   
+Cross-reference:
 
 * :ref:`genindex`

specdomain/src/specdomain/doc/starter.py

@@ -19 +19 @@
     :param str parent: path to *build* subdirectory (either ``build`` or ``_build``)
     '''
-    if os.path.exists(parent):
+    if os.path.exists(parent+'/doctrees'):
         garbage_list = [
             parent+'/doctrees/environment.pickle',
-            parent+'/doctrees/index.doctree',
-            parent+'/doctrees/test_doc.doctree',
+            #parent+'/doctrees/index.doctree',
+            #parent+'/doctrees/test_doc.doctree',
         ]
         for item in garbage_list:
             if os.path.exists(item):
                 os.remove(item)
-        os.rmdir(parent+'/doctrees')
+        #os.rmdir(parent+'/doctrees')
 
 

specdomain/src/specdomain/sphinxcontrib/specdomain.py

@@ -96 +96 @@
         arglist = m.groups()
         name = arglist[0]
-        args = ['need to fix this']
+        args = []
         if len(arglist) > 1:
             args = arglist[1:]
@@ -106 +106 @@
                 arglist = m.groups()
                 name = arglist[0].strip('"')
-                args = []                       # FIXME:
+                args = ['<<< cdef argument list not handled yet >>>']       # FIXME:
         signode += addnodes.desc_name(name, name)
         if len(args) > 0:

specdomain/src/specdomain/test/starter.py

@@ -22 +22 @@
         garbage_list = [
             parent+'/doctrees/environment.pickle',
-            parent+'/doctrees/index.doctree',
-            parent+'/doctrees/test_doc.doctree',
+            #parent+'/doctrees/index.doctree',
+            #parent+'/doctrees/test_doc.doctree',
         ]
         for item in garbage_list:
             if os.path.exists(item):
                 os.remove(item)
-        os.rmdir(parent+'/doctrees')
+        #os.rmdir(parent+'/doctrees')