diff --git a/docs/fastkml.rst b/docs/fastkml.rst index 97a33cd2..96553566 100644 --- a/docs/fastkml.rst +++ b/docs/fastkml.rst @@ -4,6 +4,15 @@ Reference Guide .. automodule:: fastkml +fastkml.kml +------------------ + +.. automodule:: fastkml.kml + :members: + :undoc-members: + :show-inheritance: + + fastkml.base ------------------- @@ -133,15 +142,6 @@ fastkml.gx :undoc-members: :show-inheritance: -fastkml.kml ------------------- - -.. automodule:: fastkml.kml - :members: - :undoc-members: - :show-inheritance: - - fastkml.links -------------------- diff --git a/fastkml/kml.py b/fastkml/kml.py index a0314c11..0886c6ba 100644 --- a/fastkml/kml.py +++ b/fastkml/kml.py @@ -153,12 +153,10 @@ def etree_element( Return an Element object representing the KML element. Args: - ---- precision (Optional[int]): The precision used for floating-point values. verbosity (Verbosity): The verbosity level for generating the KML element. Returns: - ------- Element: The etree Element object representing the KML element. """ @@ -211,14 +209,11 @@ def parse( Parse a KML file and return a KML object. Args: - ---- - file: The file to parse. - Can be a file path (str or Path), or a file-like object. + file: The file to parse. Can be a file path or a file-like object. Keyword Args: - ------------ ns (Optional[str]): The namespace of the KML file. - If not provided, it will be inferred from the root element. + If not provided, it will be inferred from the root element. name_spaces (Optional[Dict[str, str]]): Additional namespaces. strict (bool): Whether to enforce strict parsing rules. Defaults to True. validate (Optional[bool]): Whether to validate the file against the schema. @@ -257,10 +252,9 @@ def write( Write KML to a file. Args: - ---- file_path: The file name where to save the file. Can be any string value - prettyprint : bool, default=True + prettyprint (bool): default=True Whether to pretty print the XML. precision (Optional[int]): The precision used for floating-point values. verbosity (Verbosity): The verbosity level for generating the KML element.