docs: small fixes to source API documentation (#498)

Author: ovv

docs/connectors/sources/README.md

@@ -39,8 +39,7 @@ For multiplatform support, Quix Streams starts the source process using the [spa
 
 Sources work by sending data to Kafka topics. Then StreamingDataFrames consume these topics.
 
-Each source provides a default topic based on its configuration. You can override the default topic by  
-specifying a topic using the `app.dataframe()` method. 
+Each source provides a default topic based on its configuration. You can override the default topic by specifying a topic using the `app.dataframe()` method. 
 
 **Example**
 

docs/connectors/sources/csv-source.md

@@ -4,7 +4,7 @@ A basic source that reads data from a single CSV file.
 
 The CSV source reads the file, produce the data and exit. It doesn't keep any state. On restart, the whole file will be re-consumed.
 
-## How to use CSV Sourceth
+## How to use CSV Source
 
 To use a CSV Source, you need to create and instance of `CSVSource` and pass it to the `app.dataframe()` method.
 

docs/connectors/sources/custom-sources.md

@@ -2,8 +2,8 @@
 
 Quix Streams also provides a set of classes to help users implement custom sources.
 
-* [`quixstreams.sources.base.BaseSource`]: This is the base class for all other sources. It defines the must have methods.
-* [`quixstreams.sources.base.Source`]: A subclass of `BaseSource` that implements some helpful methods for writing sources. We recommend subclassing `Source` instead of `BaseSource`.
+* [`quixstreams.sources.base.Source`](../../api-reference/sources.md#sources): A subclass of `BaseSource` that implements some helpful methods for writing sources. We recommend subclassing `Source` instead of `BaseSource`.
+* [`quixstreams.sources.base.BaseSource`](../../api-reference/sources.md#BaseSource): This is the base class for all other sources. It defines the must have methods.
 
 ## Source
 
@@ -36,7 +36,7 @@ class MySource(Source):
                 )
 ```
 
-For more information, see [`quixstreams.sources.base.Source`](../../api-reference/sources.md#sources) docstrings.
+For more information, see [`quixstreams.sources.base.Source`](../../api-reference/sources.md#source) docstrings.
 
 ## BaseSource
 

quixstreams/sources/base.py

@@ -238,9 +238,9 @@ def serialize(
         timestamp_ms: Optional[int] = None,
     ) -> KafkaMessage:
         """
-        Serialize data to bytes using the producer topic serializers and return a :class:`quixstreams.models.messages.KafkaMessage` .
+        Serialize data to bytes using the producer topic serializers and return a `quixstreams.models.messages.KafkaMessage`.
 
-        :return: :class:`quixstreams.models.messages.KafkaMessage`
+        :return: `quixstreams.models.messages.KafkaMessage`
         """
         return self._producer_topic.serialize(
             key=key, value=value, headers=headers, timestamp_ms=timestamp_ms
@@ -294,7 +294,7 @@ def default_topic(self) -> Topic:
         Return a default topic matching the source name.
         The default topic will not be used if the topic has already been provided to the source.
 
-        :return: `:class:`quixstreams.models.topics.Topic`
+        :return: `quixstreams.models.topics.Topic`
         """
         return Topic(
             name=self.name,

quixstreams/sources/csv.py

@@ -20,7 +20,7 @@ def __init__(
     ) -> None:
         """
         A base CSV source that reads data from a single CSV file.
-        Best used with :class:`quixstreams.sinks.csv.CSVSink`.
+        Best used with `quixstreams.sinks.csv.CSVSink`.
 
         Required columns: key, value
         Optional columns: timestamp

quixstreams/sources/manager.py

@@ -114,7 +114,7 @@ def start(self) -> "SourceProcess":
 
     def raise_for_error(self) -> None:
         """
-        Raise a :class:`quixstreams.sources.manager.SourceException`
+        Raise a `quixstreams.sources.manager.SourceException`
         if the child process was terminated with an exception.
         """
         if super().is_alive():