MCPcopy Index your code
hub / github.com/python/cpython / writedoc

Function writedoc

Lib/pydoc.py:1764–1770  ·  view source on GitHub ↗

Write HTML documentation to a file in the current directory.

(thing, forceload=0)

Source from the content-addressed store, hash-verified

1762 output.write(s)
1763
1764def writedoc(thing, forceload=0):
1765 """Write HTML documentation to a file in the current directory."""
1766 object, name = resolve(thing, forceload)
1767 page = html.page(describe(object), html.document(object, name))
1768 with open(name + '.html', 'w', encoding='utf-8') as file:
1769 file.write(page)
1770 print('wrote', name + '.html')
1771
1772def writedocs(dir, pkgpath='', done=None):
1773 """Write out HTML documentation for all modules in a directory tree."""

Callers 2

writedocsFunction · 0.85
cliFunction · 0.85

Calls 6

describeFunction · 0.85
documentMethod · 0.80
resolveFunction · 0.70
openFunction · 0.70
pageMethod · 0.45
writeMethod · 0.45

Tested by

no test coverage detected

Used in the wild real call sites across dependent graphs

searching dependent graphs…