ganeti/server API Documentation Modules Classes Names

search in docstrings

Search bar offers the following options:

Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
Wildcards. The below example searches for documents with words beginning with “foo”: foo*
Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.
Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Exception ReSTError

Module sphinx_ext

Classes

OpcodeError
OpcodeParams
OpcodeResult
PythonAssert
RapiAccessTable
RapiResourceDetails
ReSTError
_ManPageXRefRole
_RapiHandlersForDocsHelper

Functions

BuildQueryFields
BuildValuesDoc
PythonEvalRole
setup
_BuildOpcodeParams
_BuildOpcodeResult
_BuildRapiAccessTable
_DescribeHandlerAccess
_EncodeRapiResourceLink
_GetCommonParamNames
_GetHandlerMethods
_MakeRapiResourceLink
_ManPageNodeClass
_ManPageRole
_ParseAlias
_SplitOption

Variables

COMMON_PARAM_NAMES
CV_ECODES_DOC
CV_ECODES_DOC_LIST
DOCUMENTED_CONSTANTS
EVAL_NS
RAPI_URI_ENCODE_RE
orig_manpage_role
_MAN_RE
_RAPI_RESOURCES_FOR_DOCS
_TAB_WIDTH

`ganeti.build.sphinx_ext.ReSTError`

exception documentation

class ReSTError(Exception):

View In Hierarchy

Custom class for generating errors in Sphinx.

API Documentation for ganeti/server, generated by pydoctor 22.9.1 at 2024-05-06 13:21:37.