sphobjinv
Command-Line Usage
API Usage
Creating and Using a Custom objects.inv
Speeding up “suggest” with python-Levenshtein (DEPRECATED)
Sphinx objects.inv v2 Syntax
API Reference
sphobjinv
Index
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
H
|
I
|
J
|
M
|
N
|
O
|
P
|
R
|
S
|
U
|
V
|
W
Symbols
--all
sphobjinv-suggest command line option
--contract
sphobjinv-convert command line option
--expand
sphobjinv-convert command line option
--help
sphobjinv command line option
sphobjinv-convert command line option
sphobjinv-suggest command line option
sphobjinv-textconv command line option
--index
sphobjinv-suggest command line option
--overwrite
sphobjinv-convert command line option
--quiet
sphobjinv-convert command line option
--score
sphobjinv-suggest command line option
--thresh
sphobjinv-suggest command line option
--url
sphobjinv-convert command line option
sphobjinv-suggest command line option
--version
sphobjinv command line option
sphobjinv-textconv command line option
-a
sphobjinv-suggest command line option
-c
sphobjinv-convert command line option
-e
sphobjinv-convert command line option
-h
sphobjinv command line option
sphobjinv-convert command line option
sphobjinv-suggest command line option
sphobjinv-textconv command line option
-i
sphobjinv-suggest command line option
-o
sphobjinv-convert command line option
-q
sphobjinv-convert command line option
-s
sphobjinv-suggest command line option
-t
sphobjinv-suggest command line option
-u
sphobjinv-convert command line option
sphobjinv-suggest command line option
-v
sphobjinv command line option
sphobjinv-textconv command line option
A
as_bytes (SuperDataObj property)
as_rst (SuperDataObj property)
as_str (SuperDataObj property)
B
BytesPlaintext (SourceTypes attribute)
BytesZlib (SourceTypes attribute)
C
compress() (in module sphobjinv.zlib)
Count (HeaderFields attribute)
count (Inventory property)
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)
DictJSON (SourceTypes attribute)
DispName (DataFields attribute)
dispname (SuperDataObj property)
dispname_abbrev (SuperDataObj property)
dispname_contracted (SuperDataObj property)
dispname_expanded (SuperDataObj property)
Domain (DataFields attribute)
domain (SuperDataObj property)
E
evolve() (SuperDataObj method)
F
FnamePlaintext (SourceTypes attribute)
FnameZlib (SourceTypes attribute)
H
header_preamble (Inventory attribute)
header_project (Inventory attribute)
header_version (Inventory attribute)
header_zlib (Inventory attribute)
HeaderFields (class in sphobjinv.enum)
I
infile
sphobjinv-convert command line option
sphobjinv-suggest command line option
sphobjinv-textconv command line option
Inventory (class in sphobjinv.inventory)
J
json_dict() (Inventory method)
(SuperDataObj method)
json_schema (in module sphobjinv.schema)
M
Manual (SourceTypes attribute)
Metadata (HeaderFields attribute)
mode
sphobjinv-convert command line option
module
sphobjinv.data
sphobjinv.enum
sphobjinv.error
sphobjinv.fileops
sphobjinv.inventory
sphobjinv.re
sphobjinv.schema
sphobjinv.zlib
N
Name (DataFields attribute)
name (SuperDataObj property)
O
objects (Inventory attribute)
objects_rst (Inventory property)
outfile
sphobjinv-convert command line option
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)
Priority (DataFields attribute)
priority (SuperDataObj property)
Project (HeaderFields attribute)
project (Inventory attribute)
ptn_data (in module sphobjinv.re)
R
readbytes() (in module sphobjinv.fileops)
readjson() (in module sphobjinv.fileops)
Role (DataFields attribute)
role (SuperDataObj property)
rst_fmt (SuperDataObj attribute)
S
search
sphobjinv-suggest command line option
source_type (Inventory attribute)
SourceTypes (class in sphobjinv.enum)
sphobjinv command line option
--help
--version
-h
-v
sphobjinv-convert command line option
--contract
--expand
--help
--overwrite
--quiet
--url
-c
-e
-h
-o
-q
-u
infile
mode
outfile
sphobjinv-suggest command line option
--all
--help
--index
--score
--thresh
--url
-a
-h
-i
-s
-t
-u
infile
search
sphobjinv-textconv command line option
--help
--version
-h
-v
infile
sphobjinv.data
module
sphobjinv.enum
module
sphobjinv.error
module
sphobjinv.fileops
module
sphobjinv.inventory
module
sphobjinv.re
module
sphobjinv.schema
module
sphobjinv.zlib
module
SphobjinvError
suggest() (Inventory method)
SuperDataObj (class in sphobjinv.data)
U
URI (DataFields attribute)
uri (SuperDataObj property)
uri_abbrev (SuperDataObj property)
uri_contracted (SuperDataObj property)
uri_expanded (SuperDataObj property)
URL (SourceTypes attribute)
urlwalk() (in module sphobjinv.fileops)
V
Version (HeaderFields attribute)
version (Inventory attribute)
VersionError
W
writebytes() (in module sphobjinv.fileops)
writejson() (in module sphobjinv.fileops)