Skip to content

Commit 9ecfb19

Browse files
committed
Cleaner hyperlinks to local files
1 parent 4527e9f commit 9ecfb19

File tree

7 files changed

+15
-15
lines changed

7 files changed

+15
-15
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Components are one of the core concepts of ReactPy. They are the foundation upon
88

99
!!! abstract "Note"
1010

11-
If you have reached this point, you should have already [installed ReactPy-Django](../learn/add-reactpy-to-a-django-project.md) through the previous steps.
11+
If you have reached this point, you should have already [installed ReactPy-Django](./add-reactpy-to-a-django-project.md) through the previous steps.
1212

1313
---
1414

docs/src/reference/components.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ We supply some pre-designed that components can be used to help simplify develop
1212

1313
This allows you to embedded any number of client-side PyScript components within traditional ReactPy components.
1414

15-
{% include-markdown "../reference/template-tag.md" start="<!--pyscript-def-start-->" end="<!--pyscript-def-end-->" %}
15+
{% include-markdown "./template-tag.md" start="<!--pyscript-def-start-->" end="<!--pyscript-def-end-->" %}
1616

17-
{% include-markdown "../reference/template-tag.md" start="<!--pyscript-raw-text-start-->" end="<!--pyscript-raw-text-end-->" %}
17+
{% include-markdown "./template-tag.md" start="<!--pyscript-raw-text-start-->" end="<!--pyscript-raw-text-end-->" %}
1818

1919
=== "components.py"
2020

@@ -58,9 +58,9 @@ This allows you to embedded any number of client-side PyScript components within
5858

5959
<!--pyscript-setup-required-end-->
6060

61-
{% include-markdown "../reference/template-tag.md" start="<!--pyscript-js-exec-start-->" end="<!--pyscript-js-exec-end-->" %}
61+
{% include-markdown "./template-tag.md" start="<!--pyscript-js-exec-start-->" end="<!--pyscript-js-exec-end-->" %}
6262

63-
{% include-markdown "../reference/template-tag.md" start="<!--pyscript-multifile-start-->" end="<!--pyscript-multifile-end-->" trailing-newlines=false preserve-includer-indent=false %}
63+
{% include-markdown "./template-tag.md" start="<!--pyscript-multifile-start-->" end="<!--pyscript-multifile-end-->" trailing-newlines=false preserve-includer-indent=false %}
6464

6565
=== "components.py"
6666

docs/src/reference/hooks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Prefabricated hooks can be used within your `components.py` to help simplify dev
2222

2323
Execute functions in the background and return the result, typically to [read](https://www.sumologic.com/glossary/crud/) data from the Django ORM.
2424

25-
The [default postprocessor](../reference/utils.md#django-query-postprocessor) expects your query function to `#!python return` a Django `#!python Model` or `#!python QuerySet`. This needs to be changed or disabled to execute other types of queries.
25+
The [default postprocessor](./utils.md#django-query-postprocessor) expects your query function to `#!python return` a Django `#!python Model` or `#!python QuerySet`. This needs [to be changed](./settings.md#reactpy_default_query_postprocessor) or disabled to execute other types of queries.
2626

2727
Query functions can be sync or async.
2828

@@ -157,7 +157,7 @@ Query functions can be sync or async.
157157

158158
This design decision was based on [Apollo's `#!javascript useQuery` hook](https://www.apollographql.com/docs/react/data/queries/), but ultimately helps avoid Django's `#!python SynchronousOnlyOperation` exceptions.
159159

160-
With the `#!python Model` or `#!python QuerySet` your function returns, this hook uses the [default postprocessor](../reference/utils.md#django-query-postprocessor) to ensure that all [deferred](https://docs.djangoproject.com/en/stable/ref/models/instances/#django.db.models.Model.get_deferred_fields) or [lazy](https://docs.djangoproject.com/en/stable/topics/db/queries/#querysets-are-lazy) fields are executed.
160+
With the `#!python Model` or `#!python QuerySet` your function returns, this hook uses the [default postprocessor](./utils.md#django-query-postprocessor) to ensure that all [deferred](https://docs.djangoproject.com/en/stable/ref/models/instances/#django.db.models.Model.get_deferred_fields) or [lazy](https://docs.djangoproject.com/en/stable/topics/db/queries/#querysets-are-lazy) fields are executed.
161161

162162
---
163163

docs/src/reference/html.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ The `pyscript` tag functions identically to HTML tags contained within `#!python
2828
{% include "../../examples/html/pyscript_tag.html" %}
2929
```
3030

31-
{% include-markdown "../reference/components.md" start="<!--pyscript-setup-required-start-->" end="<!--pyscript-setup-required-end-->" %}
31+
{% include-markdown "./components.md" start="<!--pyscript-setup-required-start-->" end="<!--pyscript-setup-required-end-->" %}

docs/src/reference/settings.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ The default host(s) that can render your ReactPy components.
145145

146146
ReactPy will use these hosts in a round-robin fashion, allowing for easy distributed computing. This is typically useful for self-hosted applications.
147147

148-
You can use the `#!python host` argument in your [template tag](../reference/template-tag.md#component) to manually override this default.
148+
You can use the `#!python host` argument in your [template tag](./template-tag.md#component) to manually override this default.
149149

150150
---
151151

@@ -164,7 +164,7 @@ During pre-rendering, there are some key differences in behavior:
164164
3. The component will be non-interactive until a WebSocket connection is formed.
165165
4. The component is re-rendered once a WebSocket connection is formed.
166166

167-
You can use the `#!python prerender` argument in your [template tag](../reference/template-tag.md#component) to manually override this default.
167+
You can use the `#!python prerender` argument in your [template tag](./template-tag.md#component) to manually override this default.
168168

169169
---
170170

docs/src/reference/template-tag.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Each component loaded via this template tag will receive a dedicated WebSocket c
5959
{% include "../../examples/python/template_tag_bad_view.py" %}
6060
```
6161

62-
_Note: If you decide to not follow this warning, you will need to use the [`register_component`](../reference/utils.md#register-component) function to manually register your components._
62+
_Note: If you decide to not follow this warning, you will need to use the [`register_component`](./utils.md#register-component) function to manually register your components._
6363

6464
<!--context-end-->
6565

@@ -107,7 +107,7 @@ Each component loaded via this template tag will receive a dedicated WebSocket c
107107

108108
??? question "Can I render components on a different server (distributed computing)?"
109109

110-
Yes! This is most commonly done through [`settings.py:REACTPY_HOSTS`](../reference/settings.md#reactpy_default_hosts). However, you can use the `#!python host` keyword to render components on a specific ASGI server.
110+
Yes! This is most commonly done through [`settings.py:REACTPY_HOSTS`](./settings.md#reactpy_default_hosts). However, you can use the `#!python host` keyword to render components on a specific ASGI server.
111111

112112
=== "my_template.html"
113113

@@ -127,7 +127,7 @@ Each component loaded via this template tag will receive a dedicated WebSocket c
127127

128128
??? question "How do I pre-render components for SEO compatibility?"
129129

130-
This is most commonly done through [`settings.py:REACTPY_PRERENDER`](../reference/settings.md#reactpy_prerender). However, you can use the `#!python prerender` keyword to pre-render a specific component.
130+
This is most commonly done through [`settings.py:REACTPY_PRERENDER`](./settings.md#reactpy_prerender). However, you can use the `#!python prerender` keyword to pre-render a specific component.
131131

132132
=== "my_template.html"
133133

docs/src/reference/utils.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Utility functions provide various miscellaneous functionality for advanced use c
1616

1717
This function is used register a Django view as a ReactPy `#!python iframe`.
1818

19-
It is mandatory to use this function alongside [`view_to_iframe`](../reference/components.md#view-to-iframe).
19+
It is mandatory to use this function alongside [`view_to_iframe`](./components.md#view-to-iframe).
2020

2121
=== "apps.py"
2222

@@ -76,7 +76,7 @@ Typically, this function is automatically called on all components contained wit
7676

7777
For security reasons, ReactPy requires all root components to be registered. However, all components contained within Django templates are automatically registered.
7878

79-
This function is commonly needed when you have configured your [`host`](../reference/template-tag.md#component) to a dedicated Django rendering application that doesn't have templates.
79+
This function is commonly needed when you have configured your [`host`](./template-tag.md#component) to a dedicated Django rendering application that doesn't have templates.
8080

8181
---
8282

0 commit comments

Comments
 (0)