1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH PDOC: "1" "June 2024" "pdoc: 14.5.0" "User Commands"
.SH NAME
pdoc: \- generate Python API documentation
.SH DESCRIPTION
usage: pdoc [\-o DIR] [\-d {markdown,google,numpy,restructuredtext}]
.IP
[\-\-include\-undocumented | \fB\-\-no\-include\-undocumented]\fR
[\-e module=url] [\-\-favicon URL] [\-\-footer\-text TEXT] [\-\-logo URL]
[\-\-logo\-link URL] [\-\-math | \fB\-\-no\-math]\fR [\-\-mermaid | \fB\-\-no\-mermaid]\fR
[\-\-search | \fB\-\-no\-search]\fR [\-\-show\-source | \fB\-\-no\-show\-source]\fR
[\-t DIR] [\-h HOST] [\-p PORT] [\-n] [\-\-help] [\-\-version]
[module ...]
.PP
Automatically generate API docs for Python modules.
.SS "Main Arguments:"
.TP
module
Python module names. These may be importable Python
module names ("pdoc.doc") or file paths
("./pdoc/doc.py"). Exclude submodules by specifying a
negative !regex pattern, e.g. "foo !foo.bar".
(default: [])
.TP
\fB\-o\fR DIR, \fB\-\-output\-directory\fR DIR
Write rendered documentation to the specified
directory, don't start a webserver. (default: None)
.SS "Customize Rendering:"
.TP
\fB\-d\fR {markdown,google,numpy,restructuredtext}, \fB\-\-docformat\fR {markdown,google,numpy,restructuredtext}
The default docstring format. For non\-Markdown
formats, pdoc will first convert matching syntax
elements to Markdown and then process everything as
Markdown. (default: restructuredtext)
.TP
\fB\-\-include\-undocumented\fR, \fB\-\-no\-include\-undocumented\fR
Show classes/functions/variables that do not have a
docstring. (default: True)
.TP
\fB\-e\fR module=url, \fB\-\-edit\-url\fR module=url
A mapping between module names and URL prefixes, used
to display an 'Edit' button. May be passed multiple
times. Example:
pdoc=https://github.com/mitmproxy/pdoc/blob/main/pdoc/
(default: [])
.TP
\fB\-\-favicon\fR URL
Specify a custom favicon URL. (default: None)
.TP
\fB\-\-footer\-text\fR TEXT
Custom text for the page footer, for example the
project name and current version number. (default:
None)
.TP
\fB\-\-logo\fR URL
Add a project logo image. (default: None)
.TP
\fB\-\-logo\-link\fR URL
Optional URL the logo should point to. (default: None)
.TP
\fB\-\-math\fR, \fB\-\-no\-math\fR
Include MathJax from a CDN to enable math formula
rendering. (default: False)
.TP
\fB\-\-mermaid\fR, \fB\-\-no\-mermaid\fR
Include Mermaid.js from a CDN to enable Mermaid
diagram rendering. (default: False)
.TP
\fB\-\-search\fR, \fB\-\-no\-search\fR
Enable search functionality if multiple modules are
documented. (default: True)
.TP
\fB\-\-show\-source\fR, \fB\-\-no\-show\-source\fR
Display "View Source" buttons. (default: True)
.TP
\fB\-t\fR DIR, \fB\-\-template\-directory\fR DIR
A directory containing Jinja2 templates to customize
output. Alternatively, put your templates in
\fI\,$XDG_CONFIG_HOME/pdoc\/\fP and pdoc will automatically find
them. (default: None)
.SS "Miscellaneous Options:"
.TP
\fB\-h\fR HOST, \fB\-\-host\fR HOST
The host on which to run the HTTP server. (default:
localhost)
.TP
\fB\-p\fR PORT, \fB\-\-port\fR PORT
The port on which to run the HTTP server. (default:
None)
.TP
\fB\-n\fR, \fB\-\-no\-browser\fR
Don't open a browser after the web server has started.
(default: False)
.TP
\fB\-\-help\fR
Show this help message and exit.
.TP
\fB\-\-version\fR
Show version information and exit.
.PP
Python: 3.11.9
Platform: Linux\-6.1.0\-21\-arm64\-aarch64\-with\-glibc2.38
.SH "SEE ALSO"
The full documentation for
.B pdoc:
is maintained as a Texinfo manual. If the
.B info
and
.B pdoc:
programs are properly installed at your site, the command
.IP
.B info pdoc:
.PP
should give you access to the complete manual.
|
