Skip to content

Commit

Permalink
Update relative docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
mdapena committed Dec 16, 2023
1 parent c81e41e commit f4b0a27
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 8 deletions.
11 changes: 6 additions & 5 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ hide:
<p style='text-align: justify;' markdown>
&emsp;&emsp;Welcome to the Getting Started section! This guide will help you install and configure Pyventus in
your project. For more detailed instructions on how to use this package, you can refer to the Pyventus
[tutorials](/tutorials) or [API reference](/api).
[tutorials](/pyventus/tutorials) or [API reference](/pyventus/api).
</p>

## Requirements

<p style='text-align: justify;' markdown>
&emsp;&emsp;Pyevents **only requires Python 3.10+** by default, which includes the [`AsyncIOEventEmitter`](/tutorials/emitters/asyncio-event-emitter)
and the [`ExecutorEventEmitter`](/tutorials/emitters/executor-event-emitter) with no additional dependencies.
&emsp;&emsp;Pyevents **only requires Python 3.10+** by default, which includes the [`AsyncIOEventEmitter`](/pyventus/tutorials/emitters/asyncio-event-emitter)
and the [`ExecutorEventEmitter`](/pyventus/tutorials/emitters/executor-event-emitter) with no additional dependencies.
However, your requirements may expand if you opt to use alternative built-in event emitter implementations.
</p>

Expand All @@ -45,8 +45,9 @@ pip install pyventus

<ul style='text-align: justify;' markdown>

<li markdown> [**Redis Queue (RQ)**](https://redis.com/glossary/redis-queue/) ─ Pyventus provides support for Redis
Queue (RQ) integration through the [`RQEventEmitter`](/tutorials/emitters/rq-event-emitter). The RQEventEmitter
<li markdown>
[**Redis Queue (RQ)**](https://redis.com/glossary/redis-queue/) ─ Pyventus provides support for Redis
Queue (RQ) integration through the [`RQEventEmitter`](/pyventus/tutorials/emitters/rq-event-emitter). The RQEventEmitter
seamlessly integrates with <a href="https://python-rq.org/" target="_blank">Python-RQ</a>, a widely-used library for
managing task queues using Redis Queue pub/sub system. By incorporating the RQEventEmitter into Pyventus, you gain the
ability to execute event handler callbacks as background jobs using RQ’s asynchronous workers. You can install it using
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -557,7 +557,7 @@ Hello, AsyncIOEventEmitter!
---

<p style='text-align: center;' markdown>
[:material-star-outline:&emsp;Getting Started&emsp;:material-star-outline:](https://mdapena.github.io/pyventus/getting-started/){ .md-button }
[:material-star-outline:&emsp;Getting Started&emsp;:material-star-outline:](/pyventus/getting-started/){ .md-button }
</p>

---
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/emitters/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
&emsp;&emsp;Pyventus includes several build-in event emitters by default. For instance, the `AsyncIOEventEmitter`
leverages the `AsyncIO` framework to handle the execution of event handler callbacks, while the `RQEventEmitter`
utilizes Redis Queue pub/sub system with workers to manage event handlers. To explore the available event emitters,
refer to the [Pyventus documentation](/getting-started).
refer to the [Pyventus documentation](/pyventus/getting-started).
</p>

!!! info "Driving Innovation Through Collaboration"
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/emitters/rq-event-emitter.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ parallel execution.
<ol style='text-align: justify;' markdown>

<li style='text-align: justify;' markdown>**Install Python RQ:**
Before proceeding, make sure you have installed the [optional Python RQ dependency](/getting-started/#optional-dependencies).
Before proceeding, make sure you have installed the [optional Python RQ dependency](/pyventus/getting-started/#optional-dependencies).
</li>

<li style='text-align: justify;' markdown>**Python RQ worker configuration:**
Expand Down

0 comments on commit f4b0a27

Please sign in to comment.