Knowledge

Pydoc

Source 📝

83: 211: 60:
Developed by Ka-Ping Yee, it is included by default in all versions of Python since Python 2.1 and is available for download for 1.5.2, 1.6, and 2.0.
216: 96: 88: 68: 63:
Pydoc is used to extract documentation from the source code itself. More comprehensive documentation is generated from external
23: 39: 143: 20: 42:, Pydoc allows Python programmers to access Python's documentation help files, generate text and 64: 46:
pages with documentation specifics, and find the appropriate module for a particular job.
118: 129: 205: 54: 78: 169: 35: 27: 144:
Charming Python: pydoc and distutils modules. Accessed 01/01/2012
43: 31: 50: 155: 196: 191: 186: 170:"PEP 256 -- Docstring Processing System Framework" 53:, from within the Python interpreter, or from a 212:Python (programming language) development tools 187:Archive of Pydoc for Python versions 1.5 to 2.5 49:Pydoc can be accessed from a module-specific 19:is the standard documentation module for the 8: 139: 137: 114: 112: 108: 97:Comparison of documentation generators 7: 192:Open source package library for PyPI 89:Free and open-source software portal 26:. Similar to the functionality of 14: 130:Using Pydoc. Accessed 11/27/2010 81: 156:"Ka-Ping Yee: Curriculum Vitae" 1: 217:Free documentation generators 233: 119:Pydoc. Accessed 11/27/2010 71:documentation system. 197:Sphinx documentation 67:documents using the 21:programming language 224: 174: 173: 166: 160: 159: 152: 146: 141: 132: 127: 121: 116: 91: 86: 85: 84: 65:reStructuredText 232: 231: 227: 226: 225: 223: 222: 221: 202: 201: 183: 178: 177: 168: 167: 163: 154: 153: 149: 142: 135: 128: 124: 117: 110: 105: 87: 82: 80: 77: 12: 11: 5: 230: 228: 220: 219: 214: 204: 203: 200: 199: 194: 189: 182: 181:External links 179: 176: 175: 161: 147: 133: 122: 107: 106: 104: 101: 100: 99: 93: 92: 76: 73: 13: 10: 9: 6: 4: 3: 2: 229: 218: 215: 213: 210: 209: 207: 198: 195: 193: 190: 188: 185: 184: 180: 171: 165: 162: 157: 151: 148: 145: 140: 138: 134: 131: 126: 123: 120: 115: 113: 109: 102: 98: 95: 94: 90: 79: 74: 72: 70: 66: 61: 58: 56: 52: 47: 45: 41: 37: 33: 29: 25: 22: 18: 164: 150: 125: 62: 59: 55:command line 48: 16: 15: 206:Categories 103:References 75:See also 57:shell. 38:within 36:Javadoc 30:within 28:Perldoc 69:Sphinx 24:Python 17:Pydoc 44:HTML 40:Java 34:and 32:Perl 51:GUI 208:: 136:^ 111:^ 172:. 158:.

Index

programming language
Python
Perldoc
Perl
Javadoc
Java
HTML
GUI
command line
reStructuredText
Sphinx
Free and open-source software portal
Comparison of documentation generators


Pydoc. Accessed 11/27/2010
Using Pydoc. Accessed 11/27/2010


Charming Python: pydoc and distutils modules. Accessed 01/01/2012
"Ka-Ping Yee: Curriculum Vitae"
"PEP 256 -- Docstring Processing System Framework"
Archive of Pydoc for Python versions 1.5 to 2.5
Open source package library for PyPI
Sphinx documentation
Categories
Python (programming language) development tools
Free documentation generators

Text is available under the Creative Commons Attribution-ShareAlike License. Additional terms may apply.