sphobjinv
stable
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
CLI Implementation (non-API)
sphobjinv
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
--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
--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
-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
-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
A
ALL (PrsConst attribute)
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)
confirm_print_if_long_list() (in module sphobjinv.cli.suggest)
CONTRACT (PrsConst attribute)
CONVERT (PrsConst attribute)
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)
DEF_BASENAME (PrsConst attribute)
DEF_OUT_EXT (PrsConst attribute)
DEF_THRESH (PrsConst attribute)
DictJSON (SourceTypes attribute)
DispName (DataFields attribute)
dispname (SuperDataObj property)
dispname_abbrev (SuperDataObj property)
dispname_contracted (SuperDataObj property)
dispname_expanded (SuperDataObj property)
do_convert() (in module sphobjinv.cli.convert)
do_suggest() (in module sphobjinv.cli.suggest)
Domain (DataFields attribute)
domain (SuperDataObj property)
E
err_format() (in module sphobjinv.cli.ui)
evolve() (SuperDataObj method)
EXPAND (PrsConst attribute)
extract_objectsinv_url_base() (in module sphobjinv.cli.suggest)
F
FnamePlaintext (SourceTypes attribute)
FnameZlib (SourceTypes attribute)
FOUND_URL (PrsConst attribute)
G
generate_index_lines() (in module sphobjinv.cli.suggest)
generate_names_only_lines() (in module sphobjinv.cli.suggest)
generate_score_index_lines() (in module sphobjinv.cli.suggest)
generate_score_lines() (in module sphobjinv.cli.suggest)
getparser() (in module sphobjinv.cli.parser)
H
header_preamble (Inventory attribute)
header_project (Inventory attribute)
header_version (Inventory attribute)
header_zlib (Inventory attribute)
HeaderFields (class in sphobjinv.enum)
HELP_CO_PARSER (PrsConst attribute)
HELP_CONV_EXTS (PrsConst attribute)
HELP_SU_PARSER (PrsConst attribute)
I
import_infile() (in module sphobjinv.cli.load)
INDEX (PrsConst attribute)
infile
sphobjinv-convert command line option
sphobjinv-suggest command line option
INFILE (PrsConst attribute)
inv_local() (in module sphobjinv.cli.load)
inv_stdin() (in module sphobjinv.cli.load)
inv_url() (in module sphobjinv.cli.load)
Inventory (class in sphobjinv.inventory)
J
JSON (PrsConst attribute)
json_dict() (Inventory method)
(SuperDataObj method)
json_schema (in module sphobjinv.schema)
M
main() (in module sphobjinv.cli.core)
Manual (SourceTypes attribute)
Metadata (HeaderFields attribute)
mode
sphobjinv-convert command line option
MODE (PrsConst attribute)
module
sphobjinv.cli.convert
sphobjinv.cli.core
sphobjinv.cli.load
sphobjinv.cli.parser
sphobjinv.cli.paths
sphobjinv.cli.suggest
sphobjinv.cli.ui
sphobjinv.cli.write
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
OUTFILE (PrsConst attribute)
OVERWRITE (PrsConst attribute)
P
p_data (in module sphobjinv.re)
PAGINATE (PrsConst attribute)
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 (PrsConst attribute)
print_divider() (in module sphobjinv.cli.suggest)
print_results_table() (in module sphobjinv.cli.suggest)
print_stderr() (in module sphobjinv.cli.ui)
print_stderr_inferred_mapping() (in module sphobjinv.cli.suggest)
print_stderr_result_count() (in module sphobjinv.cli.suggest)
Priority (DataFields attribute)
priority (SuperDataObj property)
Project (HeaderFields attribute)
project (Inventory attribute)
PrsConst (class in sphobjinv.cli.parser)
ptn_data (in module sphobjinv.re)
Q
QUIET (PrsConst attribute)
R
readbytes() (in module sphobjinv.fileops)
readjson() (in module sphobjinv.fileops)
resolve_inpath() (in module sphobjinv.cli.paths)
resolve_outpath() (in module sphobjinv.cli.paths)
Role (DataFields attribute)
role (SuperDataObj property)
rst_fmt (SuperDataObj attribute)
S
SCORE (PrsConst attribute)
search
sphobjinv-suggest command line option
SEARCH (PrsConst attribute)
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.cli.convert
module
sphobjinv.cli.core
module
sphobjinv.cli.load
module
sphobjinv.cli.parser
module
sphobjinv.cli.paths
module
sphobjinv.cli.suggest
module
sphobjinv.cli.ui
module
sphobjinv.cli.write
module
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
SUBPARSER_NAME (PrsConst attribute)
SUGGEST (PrsConst attribute)
suggest() (Inventory method)
SUGGEST_CONFIRM_LENGTH (PrsConst attribute)
SuperDataObj (class in sphobjinv.data)
T
THRESH (PrsConst attribute)
U
URI (DataFields attribute)
uri (SuperDataObj property)
uri_abbrev (SuperDataObj property)
uri_contracted (SuperDataObj property)
uri_expanded (SuperDataObj property)
URL (PrsConst attribute)
(SourceTypes attribute)
urlwalk() (in module sphobjinv.fileops)
V
VER_TXT (PrsConst attribute)
Version (HeaderFields attribute)
version (Inventory attribute)
VERSION (PrsConst attribute)
VersionError
W
write_file() (in module sphobjinv.cli.write)
write_json() (in module sphobjinv.cli.write)
write_plaintext() (in module sphobjinv.cli.write)
write_stdout() (in module sphobjinv.cli.write)
write_zlib() (in module sphobjinv.cli.write)
writebytes() (in module sphobjinv.fileops)
writejson() (in module sphobjinv.fileops)
Y
yesno_prompt() (in module sphobjinv.cli.ui)
Z
ZLIB (PrsConst attribute)
Read the Docs
v: stable
Versions
latest
stable
v2.3
v2.2
v2.1
v2.0
v1.0.post1
v1.0
release-2.3.1
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds