Better mkdocstrings

Author: Archmonger

.github/workflows/test-docs.yml

@@ -20,17 +20,20 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      - name: Check docs build
+      - name: Install Python Dependencies
         run: |
           pip install -r requirements/build-docs.txt
+          pip install -r requirements/check-types.txt
+          pip install -r requirements/check-style.txt
+          pip install -e .
+      - name: Check docs build
+        run: |
           linkcheckMarkdown docs/ -v -r
           linkcheckMarkdown README.md -v -r
           linkcheckMarkdown CHANGELOG.md -v -r
           cd docs
           mkdocs build --strict
       - name: Check docs examples
         run: |
-          pip install -r requirements/check-types.txt
-          pip install -r requirements/check-style.txt
           mypy --show-error-codes docs/examples/python/
           ruff check docs/examples/python/

docs/examples/python/route-parameters.py

@@ -2,8 +2,7 @@
 
 from reactpy import component, html, run
 
-from reactpy_router import browser_router, link, route
-from reactpy_router.core import use_params
+from reactpy_router import browser_router, link, route, use_params
 
 message_data: list["MessageDataType"] = [
     {"id": 1, "with": ["Alice"], "from": None, "message": "Hello!"},

docs/mkdocs.yml

@@ -96,8 +96,8 @@ plugins:
             - https://reactpy.dev/docs/objects.inv
             - https://installer.readthedocs.io/en/stable/objects.inv
           options:
-            show_root_heading: true
             show_bases: false
+            show_root_members_full_path: true
 extra:
   generator: false
   version:

docs/src/learn/hooks.md

@@ -8,7 +8,7 @@ Several pre-fabricated hooks are provided to help integrate with routing feature
 
 ## Use Search Parameters
 
-The [`use_search_params`][src.reactpy_router.use_search_params] hook can be used to access query parameters from the current location. It returns a dictionary of query parameters, where each value is a list of strings.
+The [`use_search_params`][reactpy_router.use_search_params] hook can be used to access query parameters from the current location. It returns a dictionary of query parameters, where each value is a list of strings.
 
 === "components.py"
 
@@ -18,7 +18,7 @@ The [`use_search_params`][src.reactpy_router.use_search_params] hook can be used
 
 ## Use Parameters
 
-The [`use_params`][src.reactpy_router.use_params] hook can be used to access route parameters from the current location. It returns a dictionary of route parameters, where each value is mapped to a value that matches the type specified in the route path.
+The [`use_params`][reactpy_router.use_params] hook can be used to access route parameters from the current location. It returns a dictionary of route parameters, where each value is mapped to a value that matches the type specified in the route path.
 
 === "components.py"
 

docs/src/learn/routers-routes-and-links.md

@@ -4,7 +4,7 @@ We include built-in components that automatically handle routing, which enable S
 
 ## Routers and Routes
 
-The [`browser_router`][src.reactpy_router.browser_router] component is one possible implementation of a [Router][src.reactpy_router.types.Router]. Routers takes a series of [route][src.reactpy_router.route] objects as positional arguments and render whatever element matches the current location.
+The [`browser_router`][reactpy_router.browser_router] component is one possible implementation of a [Router][reactpy_router.types.Router]. Routers takes a series of [route][reactpy_router.route] objects as positional arguments and render whatever element matches the current location.
 
 !!! abstract "Note"
 
@@ -23,7 +23,7 @@ Here we'll note some special syntax in the route path for the second route. The
 
 ### Browser Router
 
-The syntax for declaring routes with the [`browser_router`][src.reactpy_router.browser_router] is very similar to the syntax used by [`starlette`](https://www.starlette.io/routing/) (a popular Python web framework). As such route parameters are declared using the following syntax:
+The syntax for declaring routes with the [`browser_router`][reactpy_router.browser_router] is very similar to the syntax used by [`starlette`](https://www.starlette.io/routing/) (a popular Python web framework). As such route parameters are declared using the following syntax:
 
 ```python linenums="0"
 /my/route/{param}
@@ -56,11 +56,11 @@ Any route parameters collected from the current location then be accessed using
 
 !!! warning "Pitfall"
 
-    While it is possible to use route parameters to capture values from query strings (such as `#!python /my/route/?foo={bar}`), this is not recommended. Instead, you should use the [`use_search_params`][src.reactpy_router.use_search_params] hook to access query string values.
+    While it is possible to use route parameters to capture values from query strings (such as `#!python /my/route/?foo={bar}`), this is not recommended. Instead, you should use the [`use_search_params`][reactpy_router.use_search_params] hook to access query string values.
 
 ## Route Links
 
-Links between routes should be created using the [link][src.reactpy_router.link] component. This will allow ReactPy to handle the transition between routes and avoid a page reload.
+Links between routes should be created using the [link][reactpy_router.link] component. This will allow ReactPy to handle the transition between routes and avoid a page reload.
 
 === "components.py"
 

docs/src/learn/your-first-app.md

@@ -1,6 +1,6 @@
 <p class="intro" markdown>
 
-Here you'll learn the various features of `reactpy-router` and how to use them. These examples will utilize the [`reactpy_router.browser_router`][src.reactpy_router.browser_router].
+Here you'll learn the various features of `reactpy-router` and how to use them. These examples will utilize the [`reactpy_router.browser_router`][reactpy_router.browser_router].
 
 </p>
 

docs/src/reference/components.md

@@ -1,4 +1,4 @@
-::: src.reactpy_router
+::: reactpy_router
 
     options:
         members: ["route", "link"]

docs/src/reference/hooks.md

@@ -1,4 +1,4 @@
-::: src.reactpy_router
+::: reactpy_router
 
     options:
         members: ["use_params", "use_search_params"]

docs/src/reference/router.md

@@ -1,4 +1,4 @@
-::: src.reactpy_router
+::: reactpy_router
 
     options:
         members: ["browser_router"]

docs/src/reference/types.md

@@ -1 +1 @@
-::: src.reactpy_router.types
+::: reactpy_router.types