Update pre-commit configuration, enhance documentation, and refine mo…

…dule exports

.pre-commit-config.yaml

@@ -1,5 +1,11 @@
 ---
+default_language_version:
+    python: python3.12
 repos:
+  - repo: https://github.com/pre-commit-ci/pre-commit-ci-config
+    rev: v1.6.1
+    hooks:
+      - id: check-pre-commit-ci-config
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
@@ -36,18 +42,11 @@ repos:
     rev: v0.3.1
     hooks:
       - id: absolufy-imports
-  - repo: https://github.com/psf/black
-    rev: 24.10.0
-    hooks:
-      - id: black
-  - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: 'v0.7.2'
     hooks:
       - id: ruff
+      - id: ruff-format
   - repo: https://github.com/PyCQA/flake8
     rev: 7.1.1
     hooks:

README.rst

@@ -108,7 +108,9 @@ Requirements
 Optional
 ---------
 
-* lxml_::
+* lxml_:
+
+.. code-block:: bash
 
     pip install --pre "fastkml[lxml]"
 

docs/configuration.rst

@@ -11,7 +11,9 @@ as its parser, but you can change this by setting the
 implementation.
 
 E.g. if you have lxml installed, but you want to use the
-standard ``xml.etree.ElementTree``, you can do this::
+standard ``xml.etree.ElementTree``, you can do this:
+
+.. code-block:: pycon
 
     >>> import fastkml.config
     >>> import xml.etree.ElementTree

docs/fastkml.rst

@@ -2,191 +2,195 @@
 Reference Guide
 ===============
 
-.. toctree::
-   :maxdepth: 4
-
-
-
 .. automodule:: fastkml
 
 
-fastkml.about module
+fastkml.about
 --------------------
 
 .. automodule:: fastkml.about
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.atom module
+fastkml.atom
 -------------------
 
 .. automodule:: fastkml.atom
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.base module
+fastkml.base
 -------------------
 
 .. automodule:: fastkml.base
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.config module
+fastkml.config
 ---------------------
 
 .. automodule:: fastkml.config
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.containers module
+fastkml.containers
 -------------------------
 
 .. automodule:: fastkml.containers
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.data module
+fastkml.data
 -------------------
 
 .. automodule:: fastkml.data
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.enums module
+fastkml.enums
 --------------------
 
 .. automodule:: fastkml.enums
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.exceptions module
+fastkml.exceptions
 -------------------------
 
 .. automodule:: fastkml.exceptions
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.features module
+fastkml.features
 -----------------------
 
 .. automodule:: fastkml.features
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.geometry module
+fastkml.geometry
 -----------------------
 
 .. automodule:: fastkml.geometry
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.gx module
+fastkml.gx
 -----------------
 
 .. automodule:: fastkml.gx
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.helpers module
+fastkml.helpers
 ----------------------
 
 .. automodule:: fastkml.helpers
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.kml module
+fastkml.kml
 ------------------
 
 .. automodule:: fastkml.kml
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.kml\_base module
+fastkml.kml\_base
 ------------------------
 
 .. automodule:: fastkml.kml_base
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.links module
+fastkml.links
 --------------------
 
 .. automodule:: fastkml.links
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.mixins module
+fastkml.mixins
 ---------------------
 
 .. automodule:: fastkml.mixins
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.overlays module
+fastkml.overlays
 -----------------------
 
 .. automodule:: fastkml.overlays
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.registry module
+fastkml.registry
 -----------------------
 
 .. automodule:: fastkml.registry
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.styles module
+fastkml.styles
 ---------------------
 
 .. automodule:: fastkml.styles
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.times module
+fastkml.times
 --------------------
 
 .. automodule:: fastkml.times
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.types module
+fastkml.types
 --------------------
 
 .. automodule:: fastkml.types
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.utils module
+fastkml.utils
 --------------------
 
 .. automodule:: fastkml.utils
    :members:
    :undoc-members:
    :show-inheritance:
 
-fastkml.views module
+fastkml.validator
+--------------------
+
+.. automodule:: fastkml.validator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+fastkml.views
 --------------------
 
 .. automodule:: fastkml.views

fastkml/about.py

@@ -18,4 +18,7 @@
 
 The only purpose of this module is to provide a version number for the package.
 """
+
 __version__ = "1.0.0b2"
+
+__all__ = ["__version__"]

fastkml/utils.py

@@ -7,7 +7,7 @@
 from typing import Type
 from typing import Union
 
-__all__ = ["find_all", "has_attribute_values"]
+__all__ = ["find", "find_all", "has_attribute_values"]
 
 
 def has_attribute_values(obj: object, **kwargs: Any) -> bool:

pyproject.toml

@@ -179,6 +179,12 @@ include = [
     "fastkml",
 ]
 
+[tool.rstcheck]
+ignore_directives = [
+    "automodule",
+]
+report_level = "WARNING"
+
 [tool.ruff]
 fix = true
 target-version = "py38"