pdoc_library_api_docs_generation_and_local_web_server.py

1import pdoc
2
3# In its most basic form, pdoc.pdoc() takes a path to a 
4# Python file or a module name and returns the generated HTML.
5html_output = pdoc.pdoc("my_project")
6
7# If you want to start a local web server to preview documentation, 
8# you can use pdoc.render.configure and pdoc.web:
9import pdoc.render
10import pdoc.web
11
12# Optional: Configure pdoc settings
13pdoc.render.configure(show_source=True)
14
15# Start a local HTTP server on port 8080 to serve documentation for "my_project"
16pdoc.web.web(["my_project"], port=8080)