sandbox/docpy-writer/markup.py

   1 # The following dictionary lists all names marked up as ``code`` in
   2 # the rest documentation.  It specifies how it should be marked up in
   3 # LaTeX.  Running mkpydoc.py writes missing entried into the
   4 # 'missing.py' file, which should be used to update this specs:
   5 codemarkup = {
   6
   7     # types
   8     'c_char': 'class',
   9     'c_wchar': 'class',
  10
  11     'c_byte': 'class',
  12     'c_ubyte': 'class',
  13
  14     'c_short': 'class',
  15     'c_ushort': 'class',
  16
  17     'c_int': 'class',
  18     'c_uint': 'class',
  19     'c_long': 'class',
  20     'c_ulong': 'class',
  21     'c_longlong': 'class',
  22     'c_ulonglong': 'class',
  23
  24     'c_void_p': 'class',
  25     'c_char_p': 'class',
  26     'c_wchar_p': 'class',
  27
  28     'c_float': 'class',
  29     'c_double': 'class',
  30
  31     'LibraryLoader': 'class',
  32
  33     'Structure': 'class',
  34     'BigEndianStructure': 'class',
  35     'BigEndianUnion': 'class',
  36     'LittleEndianStructure': 'class',
  37     'LittleEndianUnion': 'class',
  38
  39     'Union': 'class',
  40
  41     'HRESULT': 'class',
  42
  43     'CDLL': 'class',
  44     'OleDLL': 'class',
  45     'PyDLL': 'class',
  46     'WinDLL': 'class',
  47
  48
  49     # instances
  50     'pythonapi': 'var',
  51     'windll': 'var',
  52     'cdll': 'var',
  53     'oledll': 'var',
  54     'pydll': 'var',
  55
  56     # constants
  57     'RTLD_GLOBAL': 'var',
  58     'RTLD_LOCAL': 'var',
  59
  60     # arguments (from inline code fragments)
  61     'dst': 'var',
  62     'init': 'var',
  63     'lib': 'var',
  64     'libname': 'var',
  65     'mode': 'var',
  66     'name': 'var',
  67     'iid': 'var',
  68     'index': 'var',
  69     'paramflags': 'var',
  70     'version': 'var',
  71     'outargs': 'var',
  72     'c': 'var',
  73     'count': 'var',
  74     'code': 'var',
  75
  76     # methods
  77     'LoadLibrary': 'method',
  78     'find': 'method',
  79     'load': 'method',
  80     'load_library': 'method',
  81     'load_version': 'method',
  82
  83     'from_address': 'method',
  84     'from_param': 'method',
  85     'in_dll': 'method',
  86
  87     '__getattr__': 'method',
  88     '__getitem__': 'method',
  89
  90     # members
  91     'restype': 'member',
  92     'argtypes': 'member',
  93     'errcheck': 'member',
  94
  95     '_fields_': 'member',
  96     '_pack_': 'member',
  97     '__ctype_be__': 'member',
  98     '__ctype_le__': 'member',
  99     '__ctypes_from_outparam__': 'member',
 100     '_as_parameter_': 'member',
 101     '_b_base_': 'member',
 102     '_b_needsfree_': 'member',
 103
 104     '_handle': 'member',
 105     '_name': 'member',
 106     '_objects': 'member',
 107     '_type_': 'member',
 108
 109     # functions
 110     'PyString_FromString': 'function',
 111     'PyString_FromStringAndSize': 'function',
 112     'PyUnicode_FromWideString': 'function',
 113
 114     'DllCanUnloadNow()': 'function',
 115     'FormatError': 'function',
 116     'GetLastError()': 'function',
 117
 118     'memmove': 'function',
 119     'memset': 'function',
 120     'qsort': 'function',
 121
 122     'CFUNCTYPE': 'function',
 123     'WINFUNCTYPE': 'function',
 124
 125     'byref': 'function',
 126     'create_string_buffer()': 'function',
 127
 128     # random things
 129     'NULL': 'code',
 130     'None': 'code',
 131     '_': 'code',
 132     '__stdcall': 'code',
 133     'atoi': 'code',
 134     'c_int.__ctype_be__': 'code',
 135     'char': 'code',
 136     'dlopen': 'code',
 137     'dlopen()': 'code',
 138     'void': 'code',
 139     'wchar_t': 'code',
 140     'wcslen': 'code',
 141     'x': 'code',
 142     'y': 'code',
 143
 144     'WindowsError': 'class',
 145
 146 }