Add package level functions to docs and update CLI docs [skip ci]

Author: jg-rp

docs/cli.md

@@ -62,6 +62,7 @@ optional arguments:
                         File to write resulting objects to, as a JSON array. Defaults to the standard
                         output stream.
   --no-type-checks      Disables filter expression well-typedness checks.
+  --strict              Compile and evaluate JSONPath expressions with strict compliance with RFC 9535.
 ```
 
 ## Global Options
@@ -191,6 +192,12 @@ _New in version 0.10.0_
 
 Disables JSONPath filter expression well-typedness checks. The well-typedness of a filter expression is defined by RFC 9535.
 
+#### `--strict`
+
+_New in version 2.0.0_
+
+Compile and evaluate JSONPath expressions with strict compliance with RFC 9535.
+
 ### `pointer`
 
 Resolve a JSON Pointer against a JSON document. One of `-p`/`--pointer` or `-r`/`--pointer-file` must be given. `-p` being a JSON Pointer given on the command line as a string, `-r` being the path to a file containing a JSON Pointer.

docs/convenience.md

@@ -0,0 +1,31 @@
+# Convenience Functions
+
+These package-level functions use the default [JSONPathEnvironment](api.md#jsonpath.JSONPathEnvironment), `jsonpath.DEFAULT_ENV` when `strict=False`, or the preconfigured strict environment, `jsonpath.STRICT_ENV` when `strict=True`.
+
+::: jsonpath.compile
+
+    handler: python
+
+::: jsonpath.findall
+
+    handler: python
+
+::: jsonpath.finditer
+
+    handler: python
+
+::: jsonpath.findall_async
+
+    handler: python
+
+::: jsonpath.finditer_async
+
+    handler: python
+
+::: jsonpath.match
+
+    handler: python
+
+::: jsonpath.query
+
+    handler: python

docs/quickstart.md

@@ -4,18 +4,18 @@ This page gets you started using JSONPath, JSON Pointer and JSON Patch wih Pytho
 
 ## `findall(path, data)`
 
-Find all values matching a JSONPath query using [`jsonpath.findall()`](api.md#jsonpath.JSONPathEnvironment.findall).
+Find all values matching a JSONPath query using [`jsonpath.findall()`](convenience.md#jsonpath.findall).
 
 This function takes two arguments:
 
-- `path`: a JSONPath query as a string (e.g., `"$.users[*].name"`)
+- `path`: a JSONPath query as a string (e.g. `"$.users[*].name"`)
 - `data`: the JSON document to query
 
 It **always** returns a list of matched values, even if the path resolves to a single result or nothing at all.
 
 The `data` argument can be:
 
-- A Python [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping) (e.g., `dict`) or [`Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence) (e.g., `list`)
+- A Python [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping) (e.g. `dict`) or [`Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence) (e.g. `list`)
 - A JSON-formatted string
 - A file-like object containing JSON
 
@@ -65,7 +65,7 @@ with open("users.json") as fd:
 
 ## `finditer(path, data)`
 
-Use [`jsonpath.finditer()`](api.md#jsonpath.JSONPathEnvironment.finditer) to iterate over instances of [`jsonpath.JSONPathMatch`](api.md#jsonpath.JSONPathMatch) for every object in _data_ that matches _path_. It accepts the same arguments as [`findall()`](#findallpath-data), a query string and data from which to select matches.
+Use [`jsonpath.finditer()`](convenience.md#jsonpath.finditer) to iterate over instances of [`jsonpath.JSONPathMatch`](api.md#jsonpath.JSONPathMatch) for every object in _data_ that matches _path_. It accepts the same arguments as [`findall()`](#findallpath-data), a query string and data from which to select matches.
 
 ```python
 import jsonpath
@@ -109,7 +109,7 @@ The selected object is available from a [`JSONPathMatch`](api.md#jsonpath.JSONPa
 
 ## `compile(path)`
 
-When you have a JSONPath query that needs to be matched against different data repeatedly, you can compile the path ahead of time using [`jsonpath.compile()`](api.md#jsonpath.JSONPathEnvironment.compile). It takes a query as a string and returns an instance of [`JSONPath`](api.md#jsonpath.JSONPath). `JSONPath` has `findall()` and `finditer()` methods that behave similarly to package-level `findall()` and `finditer()`, just without the `path` argument.
+When you have a JSONPath query that needs to be matched against different data repeatedly, you can compile the path ahead of time using [`jsonpath.compile()`](convenience.md#jsonpath.compile). It takes a query as a string and returns an instance of [`JSONPath`](api.md#jsonpath.JSONPath). `JSONPath` has `findall()` and `finditer()` methods that behave similarly to package-level `findall()` and `finditer()`, just without the `path` argument.
 
 ```python
 import jsonpath

mkdocs.yml

@@ -53,6 +53,7 @@ nav:
       - JSON Pointers: "pointers.md"
       - Async Support: "async.md"
   - API Reference:
+      - Package Level Functions: "convenience.md"
       - High Level API: "api.md"
       - Low Level API: "custom_api.md"
       - Exceptions: "exceptions.md"