sphobjinv
v2.0
Command-Line Usage
API Usage
Creating and Using a Custom objects.inv
Speeding up “suggest” with python-Levenshtein
Sphinx objects.inv v2 Syntax
API
CLI Implementation (non-API)
sphobjinv
Docs
»
Index
Edit on GitHub
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
|
Z
Symbols
-a, --all
sphobjinv-suggest command line option
-c, --contract
sphobjinv-convert command line option
-e, --expand
sphobjinv-convert command line option
-h, --help
sphobjinv command line option
sphobjinv-convert command line option
sphobjinv-suggest command line option
-i, --index
sphobjinv-suggest command line option
-o, --overwrite
sphobjinv-convert command line option
-q, --quiet
sphobjinv-convert command line option
-s, --score
sphobjinv-suggest command line option
-t, --thresh <#>
sphobjinv-suggest command line option
-u, --url
sphobjinv-convert command line option
sphobjinv-suggest command line option
-v, --version
sphobjinv command line option
A
ALL (in module sphobjinv.cmdline)
as_bytes (DataObjBytes attribute)
(DataObjStr attribute)
(SuperDataObj attribute)
as_rst (SuperDataObj attribute)
as_str (DataObjBytes attribute)
(DataObjStr attribute)
(SuperDataObj attribute)
B
BytesPlaintext (SourceTypes attribute)
BytesZlib (SourceTypes attribute)
C
compress() (in module sphobjinv.zlib)
CONTRACT (in module sphobjinv.cmdline)
CONVERT (in module sphobjinv.cmdline)
Count (HeaderFields attribute)
count (Inventory attribute)
D
data_file() (Inventory method)
data_line() (SuperDataObj method)
data_line_fmt (SuperDataObj attribute)
DataFields (class in sphobjinv.data)
DataObjBytes (class in sphobjinv.data)
DataObjStr (class in sphobjinv.data)
decompress() (in module sphobjinv.zlib)
DEF_BASENAME (in module sphobjinv.cmdline)
DEF_OUT_EXT (in module sphobjinv.cmdline)
DEF_THRESH (in module sphobjinv.cmdline)
DictJSON (SourceTypes attribute)
DispName (DataFields attribute)
dispname (DataObjBytes attribute)
(DataObjStr attribute)
(SuperDataObj attribute)
dispname_abbrev (SuperDataObj attribute)
dispname_contracted (SuperDataObj attribute)
dispname_expanded (SuperDataObj attribute)
do_convert() (in module sphobjinv.cmdline)
do_suggest() (in module sphobjinv.cmdline)
Domain (DataFields attribute)
domain (DataObjBytes attribute)
(DataObjStr attribute)
(SuperDataObj attribute)
E
err_format() (in module sphobjinv.cmdline)
evolve() (SuperDataObj method)
EXPAND (in module sphobjinv.cmdline)
F
FnamePlaintext (SourceTypes attribute)
FnameZlib (SourceTypes attribute)
G
getparser() (in module sphobjinv.cmdline)
H
header_preamble (Inventory attribute)
header_project (Inventory attribute)
header_version (Inventory attribute)
header_zlib (Inventory attribute)
HeaderFields (class in sphobjinv.inventory)
HELP_CO_PARSER (in module sphobjinv.cmdline)
HELP_CONV_EXTS (in module sphobjinv.cmdline)
HELP_SU_PARSER (in module sphobjinv.cmdline)
I
import_infile() (in module sphobjinv.cmdline)
INDEX (in module sphobjinv.cmdline)
infile
sphobjinv-convert command line option
sphobjinv-suggest command line option
INFILE (in module sphobjinv.cmdline)
inv_local() (in module sphobjinv.cmdline)
inv_url() (in module sphobjinv.cmdline)
Inventory (class in sphobjinv.inventory)
J
JSON (in module sphobjinv.cmdline)
json_dict() (Inventory method)
(SuperDataObj method)
json_schema (in module sphobjinv.schema)
M
main() (in module sphobjinv.cmdline)
Manual (SourceTypes attribute)
Metadata (HeaderFields attribute)
mode
sphobjinv-convert command line option
MODE (in module sphobjinv.cmdline)
N
Name (DataFields attribute)
name (DataObjBytes attribute)
(DataObjStr attribute)
(SuperDataObj attribute)
O
objects (Inventory attribute)
objects_rst (Inventory attribute)
outfile
sphobjinv-convert command line option
OUTFILE (in module sphobjinv.cmdline)
OVERWRITE (in module sphobjinv.cmdline)
P
p_data (in module sphobjinv.re)
pb_comments (in module sphobjinv.re)
pb_data (in module sphobjinv.re)
pb_project (in module sphobjinv.re)
pb_version (in module sphobjinv.re)
PLAIN (in module sphobjinv.cmdline)
Priority (DataFields attribute)
priority (DataObjBytes attribute)
(DataObjStr attribute)
(SuperDataObj attribute)
Project (HeaderFields attribute)
project (Inventory attribute)
ptn_data (in module sphobjinv.re)
Q
QUIET (in module sphobjinv.cmdline)
R
readbytes() (in module sphobjinv.fileops)
readjson() (in module sphobjinv.fileops)
resolve_inpath() (in module sphobjinv.cmdline)
resolve_outpath() (in module sphobjinv.cmdline)
Role (DataFields attribute)
role (DataObjBytes attribute)
(DataObjStr attribute)
(SuperDataObj attribute)
rst_fmt (SuperDataObj attribute)
S
SCORE (in module sphobjinv.cmdline)
search
sphobjinv-suggest command line option
SEARCH (in module sphobjinv.cmdline)
selective_print() (in module sphobjinv.cmdline)
source_type (Inventory attribute)
SourceTypes (class in sphobjinv.inventory)
sphobjinv command line option
-h, --help
-v, --version
sphobjinv-convert command line option
-c, --contract
-e, --expand
-h, --help
-o, --overwrite
-q, --quiet
-u, --url
infile
mode
outfile
sphobjinv-suggest command line option
-a, --all
-h, --help
-i, --index
-s, --score
-t, --thresh <#>
-u, --url
infile
search
sphobjinv.cmdline (module)
sphobjinv.data (module)
sphobjinv.error (module)
sphobjinv.fileops (module)
sphobjinv.inventory (module)
sphobjinv.re (module)
sphobjinv.schema (module)
sphobjinv.zlib (module)
SphobjinvError
SUBPARSER_NAME (in module sphobjinv.cmdline)
SUGGEST (in module sphobjinv.cmdline)
suggest() (Inventory method)
SUGGEST_CONFIRM_LENGTH (in module sphobjinv.cmdline)
SuperDataObj (class in sphobjinv.data)
T
THRESH (in module sphobjinv.cmdline)
U
URI (DataFields attribute)
uri (DataObjBytes attribute)
(DataObjStr attribute)
(SuperDataObj attribute)
uri_abbrev (SuperDataObj attribute)
uri_contracted (SuperDataObj attribute)
uri_expanded (SuperDataObj attribute)
URL (in module sphobjinv.cmdline)
(SourceTypes attribute)
urlwalk() (in module sphobjinv.fileops)
V
VER_TXT (in module sphobjinv.cmdline)
Version (HeaderFields attribute)
VERSION (in module sphobjinv.cmdline)
version (Inventory attribute)
VersionError
W
write_json() (in module sphobjinv.cmdline)
write_plaintext() (in module sphobjinv.cmdline)
write_zlib() (in module sphobjinv.cmdline)
writebytes() (in module sphobjinv.fileops)
writejson() (in module sphobjinv.fileops)
Y
yesno_prompt() (in module sphobjinv.cmdline)
Z
ZLIB (in module sphobjinv.cmdline)
Read the Docs
v: v2.0
Versions
latest
stable
v2.0
v2.0rc1
v1.0.post1
v1.0
v.doc
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.