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
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH AUTODOC2 "1" "August 2024" "autodoc2 version: 0.5.0" "User Commands"
.SH NAME
autodoc2 \- Sphinx extension to automatically generate API doc for Py packages
.SH DESCRIPTION
.IP
Usage: autodoc2 [OPTIONS] COMMAND [ARGS]...
.IP
CLI for sphinx\-autodoc2
.PP
Options
\fB\-\-version\fR \fB\-v\fR Show the application version and exit.
\fB\-\-install\-completion\fR Install completion for the current shell.
\fB\-\-show\-completion\fR Show completion for the current shell, to copy it or customize the installation.
\fB\-\-help\fR \fB\-h\fR Show this message and exit.
Commands
create\-db Create a database for a python module or package.
list Analyse a python module or package and stream the results to the console.
resolve\-all Analyse the __all__ of a module and find potential matches
write Create sphinx files for a python module or package.
.SH "SEE ALSO"
The full documentation for
.B autodoc2
is maintained as a Texinfo manual. If the
.B info
and
.B autodoc2
programs are properly installed at your site, the command
.IP
.B info autodoc2
.PP
should give you access to the complete manual.
|
