asciidoxy/generator/asciidoc.py
def find_element(self,
                     name: str,
                     *,
                     kind: Optional[str] = None,
                     lang: Optional[str] = None,
                     allow_overloads: bool = False) -> ReferableElement:
        """Find a reference to API documentation.

        Only `name` is mandatory. Multiple names may match the same name. Use `kind` and `lang` to
        disambiguate.

        Args:
            name:            Name of the object to insert.
            kind:            Kind of object to generate reference documentation for.
            lang:            Programming language of the object.
            allow_overloads: True to return the first match of an overload set.

        Returns:
            An API documentation reference.

        Raises:
             AmbiguousReferenceError: There are multiple elements matching the criteria.
             ReferenceNotFoundError: There are no elements matching the criteria.
        """
        if lang is not None:
            lang = safe_language_tag(lang)
        else:
            lang = self._context.language

        try:
            element = self._context.reference.find(name=name,
                                                   namespace=self._context.namespace,
                                                   kind=kind,
                                                   lang=lang,
                                                   allow_overloads=allow_overloads)
        except AmbiguousLookupError as ex:
            raise AmbiguousReferenceError(name, ex.candidates)

        if element is None:
            raise ReferenceNotFoundError(name, lang=lang, kind=kind)
        return element
Find a reference to API documentation.

        Only `name` is mandatory. Multiple names may match the same name. Use `kind` and `lang` to
        disambiguate.

        Args:
            name:            Name of the object to insert.
            kind:            Kind of object to generate reference documentation for.
            lang:            Programming language of the object.
            allow_overloads: True to return the first match of an overload set.

        Returns:
            An API documentation reference.

        Raises:
             AmbiguousReferenceError: There are multiple elements matching the criteria.
             ReferenceNotFoundError: There are no elements matching the criteria.
        
Find a reference to API documentation.
Only `name` is mandatory. Multiple names may match the same name. Use `kind` and `lang` to
disambiguate.
Find a reference to API documentation . Only ` name ` is mandatory . Multiple names may match the same name . Use ` kind ` and ` lang ` to disambiguate .
def find_element(self,
                     name: str,
                     *,
                     kind: Optional[str] = None,
                     lang: Optional[str] = None,
                     allow_overloads: bool = False) -> ReferableElement:
        if lang is not None:
            lang = safe_language_tag(lang)
        else:
            lang = self._context.language
        try:
            element = self._context.reference.find(name=name,
                                                   namespace=self._context.namespace,
                                                   kind=kind,
                                                   lang=lang,
                                                   allow_overloads=allow_overloads)
        except AmbiguousLookupError as ex:
            raise AmbiguousReferenceError(name, ex.candidates)
        if element is None:
            raise ReferenceNotFoundError(name, lang=lang, kind=kind)
        return element
def find_element ( self , name : str , * , kind : Optional [ str ] = None , lang : Optional [ str ] = None , allow_overloads : bool = False ) -> ReferableElement : if lang is not None : lang = safe_language_tag ( lang ) else : lang = self . _context . language try : element = self . _context . reference . find ( name = name , namespace = self . _context . namespace , kind = kind , lang = lang , allow_overloads = allow_overloads ) except AmbiguousLookupError as ex : raise AmbiguousReferenceError ( name , ex . candidates ) if element is None : raise ReferenceNotFoundError ( name , lang = lang , kind = kind ) return element
Find a reference to API documentation.
Find a reference to API documentation .
"""Find a reference to API documentation.

        Only `name` is mandatory. Multiple names may match the same name. Use `kind` and `lang` to
        disambiguate.

        Args:
            name:            Name of the object to insert.
            kind:            Kind of object to generate reference documentation for.
            lang:            Programming language of the object.
            allow_overloads: True to return the first match of an overload set.

        Returns:
            An API documentation reference.

        Raises:
             AmbiguousReferenceError: There are multiple elements matching the criteria.
             ReferenceNotFoundError: There are no elements matching the criteria.
        """
An API documentation reference.
An API documentation reference .
There are multiple elements matching the criteria.
There are multiple elements matching the criteria .
AmbiguousReferenceError
There are no elements matching the criteria.
There are no elements matching the criteria .
ReferenceNotFoundError
self
name
str
Name of the object to insert.
Name of the object to insert .
kind
Optional[str]
Kind of object to generate reference documentation for.
Kind of object to generate reference documentation for .
lang
Optional[str]
Programming language of the object.
Programming language of the object .
allow_overloads
bool
True to return the first match of an overload set.
True to return the first match of an overload set .