Fix broken links (#665)

* Fix broken link

Uses relative links instead of hardcoded URLs.

* remove inheritance doc from the Document docstring

* remove inheritance doc from the query classes

---------

Co-authored-by: Roman <[email protected]>

Author: tsabsch

CONTRIBUTING.md

@@ -1,4 +1,4 @@
 Contributing
 ------------
 
-Please check [this page in the documentation](https://roman-right.github.io/beanie/development/).
+Please check [this page in the documentation](https://beanie-odm.dev/development/).

README.md

@@ -1,6 +1,6 @@
 [![Beanie](https://raw.githubusercontent.com/roman-right/beanie/main/assets/logo/white_bg.svg)](https://github.com/roman-right/beanie)
 
-[![shields badge](https://shields.io/badge/-docs-blue)](https://roman-right.github.io/beanie/)
+[![shields badge](https://shields.io/badge/-docs-blue)](https://beanie-odm.dev)
 [![pypi](https://img.shields.io/pypi/v/beanie.svg)](https://pypi.python.org/pypi/beanie)
 
 ## Overview
@@ -85,7 +85,7 @@ if __name__ == "__main__":
 
 ### Documentation
 
-- **[Doc](https://roman-right.github.io/beanie/)** - Tutorial, API documentation, and development guidelines.
+- **[Doc](https://beanie-odm.dev/)** - Tutorial, API documentation, and development guidelines.
 
 ### Example Projects
 
@@ -109,7 +109,7 @@ Iliya Hosseini](https://github.com/IHosseini083)
 
 - **[GitHub](https://github.com/roman-right/beanie)** - GitHub page of the
   project
-- **[Changelog](https://roman-right.github.io/beanie/changelog)** - list of all
+- **[Changelog](https://beanie-odm.dev/changelog)** - list of all
   the valuable changes
 - **[Discord](https://discord.gg/29mMrEBvr4)** - ask your questions, share
   ideas or just say `Hello!!`

beanie/odm/documents.py

@@ -137,11 +137,6 @@ class Document(
 
     - `id` - MongoDB document ObjectID "_id" field.
     Mapped to the PydanticObjectId class
-
-    Inherited from:
-
-    - Pydantic BaseModel
-    - [UpdateMethods](https://roman-right.github.io/beanie/api/interfaces/#aggregatemethods)
     """
 
     if IS_PYDANTIC_V2:
@@ -732,7 +727,7 @@ class Sample(Document):
 
         ```
 
-        Uses [Set operator](https://roman-right.github.io/beanie/api/operators/update/#set)
+        Uses [Set operator](operators/update.md#set)
 
         :param expression: Dict[Union[ExpressionField, str], Any] - keys and
         values to set
@@ -760,7 +755,7 @@ def current_date(
         """
         Set current date
 
-        Uses [CurrentDate operator](https://roman-right.github.io/beanie/api/operators/update/#currentdate)
+        Uses [CurrentDate operator](operators/update.md#currentdate)
 
         :param expression: Dict[Union[ExpressionField, str], Any]
         :param session: Optional[ClientSession] - pymongo session
@@ -798,7 +793,7 @@ class Sample(Document):
 
         ```
 
-        Uses [Inc operator](https://roman-right.github.io/beanie/api/operators/update/#inc)
+        Uses [Inc operator](operators/update.md#inc)
 
         :param expression: Dict[Union[ExpressionField, str], Any]
         :param session: Optional[ClientSession] - pymongo session

beanie/odm/interfaces/aggregate.py

@@ -55,13 +55,13 @@ def aggregate(
     ]:
         """
         Aggregate over collection.
-        Returns [AggregationQuery](https://roman-right.github.io/beanie/api/queries/#aggregationquery) query object
+        Returns [AggregationQuery](query.md#aggregationquery) query object
         :param aggregation_pipeline: list - aggregation pipeline
         :param projection_model: Type[BaseModel]
         :param session: Optional[ClientSession]
         :param ignore_cache: bool
         :param **pymongo_kwargs: pymongo native parameters for aggregate operation
-        :return: [AggregationQuery](https://roman-right.github.io/beanie/api/queries/#aggregationquery)
+        :return: [AggregationQuery](query.md#aggregationquery)
         """
         return cls.find_all().aggregate(
             aggregation_pipeline=aggregation_pipeline,

beanie/odm/interfaces/find.py

@@ -91,15 +91,15 @@ def find_one(  # type: ignore
     ) -> Union[FindOne["DocType"], FindOne["DocumentProjectionType"]]:
         """
         Find one document by criteria.
-        Returns [FindOne](https://roman-right.github.io/beanie/api/queries/#findone) query object.
+        Returns [FindOne](query.md#findone) query object.
         When awaited this will either return a document or None if no document exists for the search criteria.
 
         :param args: *Mapping[str, Any] - search criteria
         :param projection_model: Optional[Type[BaseModel]] - projection model
         :param session: Optional[ClientSession] - pymongo session instance
         :param ignore_cache: bool
         :param **pymongo_kwargs: pymongo native parameters for find operation (if Document class contains links, this parameter must fit the respective parameter of the aggregate MongoDB function)
-        :return: [FindOne](https://roman-right.github.io/beanie/api/queries/#findone) - find query instance
+        :return: [FindOne](query.md#findone) - find query instance
         """
         args = cls._add_class_id_filter(args, with_children)
         return cls._find_one_query_class(document_model=cls).find_one(
@@ -164,7 +164,7 @@ def find_many(  # type: ignore
     ) -> Union[FindMany["DocType"], FindMany["DocumentProjectionType"]]:
         """
         Find many documents by criteria.
-        Returns [FindMany](https://roman-right.github.io/beanie/api/queries/#findmany) query object
+        Returns [FindMany](query.md#findmany) query object
 
         :param args: *Mapping[str, Any] - search criteria
         :param skip: Optional[int] - The number of documents to omit.
@@ -175,7 +175,7 @@ def find_many(  # type: ignore
         :param ignore_cache: bool
         :param lazy_parse: bool
         :param **pymongo_kwargs: pymongo native parameters for find operation (if Document class contains links, this parameter must fit the respective parameter of the aggregate MongoDB function)
-        :return: [FindMany](https://roman-right.github.io/beanie/api/queries/#findmany) - query instance
+        :return: [FindMany](query.md#findmany) - query instance
         """
         args = cls._add_class_id_filter(args, with_children)
         return cls._find_many_query_class(document_model=cls).find_many(
@@ -313,7 +313,7 @@ def find_all(  # type: ignore
         :param projection_model: Optional[Type[BaseModel]] - projection model
         :param session: Optional[ClientSession] - pymongo session
         :param **pymongo_kwargs: pymongo native parameters for find operation (if Document class contains links, this parameter must fit the respective parameter of the aggregate MongoDB function)
-        :return: [FindMany](https://roman-right.github.io/beanie/api/queries/#findmany) - query instance
+        :return: [FindMany](query.md#findmany) - query instance
         """
         return cls.find_many(
             {},

beanie/odm/interfaces/update.py

@@ -48,7 +48,7 @@ class Sample(Document):
 
         ```
 
-        Uses [Set operator](https://roman-right.github.io/beanie/api/operators/update/#set)
+        Uses [Set operator](operators/update.md#set)
 
         :param expression: Dict[Union[ExpressionField, str], Any] - keys and
         values to set
@@ -70,7 +70,7 @@ def current_date(
         """
         Set current date
 
-        Uses [CurrentDate operator](https://roman-right.github.io/beanie/api/operators/update/#currentdate)
+        Uses [CurrentDate operator](operators/update.md#currentdate)
 
         :param expression: Dict[Union[ExpressionField, str], Any]
         :param session: Optional[ClientSession] - pymongo session
@@ -105,7 +105,7 @@ class Sample(Document):
 
         ```
 
-        Uses [Inc operator](https://roman-right.github.io/beanie/api/operators/update/#inc)
+        Uses [Inc operator](operators/update.md#inc)
 
         :param expression: Dict[Union[ExpressionField, str], Any]
         :param session: Optional[ClientSession] - pymongo session

beanie/odm/queries/aggregation.py

@@ -33,11 +33,6 @@ class AggregationQuery(
 ):
     """
     Aggregation Query
-
-    Inherited from:
-
-    - [SessionMethods](https://roman-right.github.io/beanie/api/interfaces/#sessionmethods) - session methods
-    - [BaseCursorQuery](https://roman-right.github.io/beanie/api/queries/#basecursorquery) - async generator
     """
 
     def __init__(

beanie/odm/queries/find.py

@@ -63,11 +63,6 @@ class FindQuery(
 ):
     """
     Find Query base class
-
-    Inherited from:
-
-    - [SessionMethods](https://roman-right.github.io/beanie/api/interfaces/#sessionmethods)
-    - [UpdateMethods](https://roman-right.github.io/beanie/api/interfaces/#aggregatemethods)
     """
 
     UpdateQueryType: Union[
@@ -173,13 +168,6 @@ class FindMany(
 ):
     """
     Find Many query class
-
-    Inherited from:
-
-    - [FindQuery](https://roman-right.github.io/beanie/api/queries/#findquery)
-    - [BaseCursorQuery](https://roman-right.github.io/beanie/api/queries/#basecursorquery) - async generator
-    - [AggregateMethods](https://roman-right.github.io/beanie/api/interfaces/#aggregatemethods)
-
     """
 
     UpdateQueryType = UpdateMany
@@ -487,11 +475,11 @@ def update_many(
     ) -> UpdateMany:
         """
         Provide search criteria to the
-        [UpdateMany](https://roman-right.github.io/beanie/api/queries/#updatemany) query
+        [UpdateMany](query.md#updatemany) query
 
         :param args: *Mapping[str,Any] - the modifications to apply.
         :param session: Optional[ClientSession]
-        :return: [UpdateMany](https://roman-right.github.io/beanie/api/queries/#updatemany) query
+        :return: [UpdateMany](query.md#updatemany) query
         """
         return cast(
             UpdateMany,
@@ -510,10 +498,10 @@ def delete_many(
         **pymongo_kwargs,
     ) -> DeleteMany:
         """
-        Provide search criteria to the [DeleteMany](https://roman-right.github.io/beanie/api/queries/#deletemany) query
+        Provide search criteria to the [DeleteMany](query.md#deletemany) query
 
         :param session:
-        :return: [DeleteMany](https://roman-right.github.io/beanie/api/queries/#deletemany) query
+        :return: [DeleteMany](query.md#deletemany) query
         """
         # We need to cast here to tell mypy that we are sure about the type.
         # This is because delete may also return a DeleteOne type in general, and mypy can not be sure in this case
@@ -559,14 +547,14 @@ def aggregate(
         AggregationQuery[FindQueryProjectionType],
     ]:
         """
-        Provide search criteria to the [AggregationQuery](https://roman-right.github.io/beanie/api/queries/#aggregationquery)
+        Provide search criteria to the [AggregationQuery](query.md#aggregationquery)
 
         :param aggregation_pipeline: list - aggregation pipeline. MongoDB doc:
         <https://docs.mongodb.com/manual/core/aggregation-pipeline/>
         :param projection_model: Type[BaseModel] - Projection Model
         :param session: Optional[ClientSession] - PyMongo session
         :param ignore_cache: bool
-        :return:[AggregationQuery](https://roman-right.github.io/beanie/api/queries/#aggregationquery)
+        :return:[AggregationQuery](query.md#aggregationquery)
         """
         self.set_session(session=session)
         find_query = self.get_filter_query()
@@ -713,10 +701,6 @@ async def count(self) -> int:
 class FindOne(FindQuery[FindQueryResultType]):
     """
     Find One query class
-
-    Inherited from:
-
-    - [FindQuery](https://roman-right.github.io/beanie/api/queries/#findquery)
     """
 
     UpdateQueryType = UpdateOne
@@ -882,12 +866,12 @@ def update_one(
         **pymongo_kwargs,
     ) -> UpdateOne:
         """
-        Create [UpdateOne](https://roman-right.github.io/beanie/api/queries/#updateone) query using modifications and
+        Create [UpdateOne](query.md#updateone) query using modifications and
         provide search criteria there
         :param args: *Mapping[str,Any] - the modifications to apply
         :param session: Optional[ClientSession] - PyMongo sessions
         :param response_type: Optional[UpdateResponse]
-        :return: [UpdateOne](https://roman-right.github.io/beanie/api/queries/#updateone) query
+        :return: [UpdateOne](query.md#updateone) query
         """
         return cast(
             UpdateOne,
@@ -907,9 +891,9 @@ def delete_one(
         **pymongo_kwargs,
     ) -> DeleteOne:
         """
-        Provide search criteria to the [DeleteOne](https://roman-right.github.io/beanie/api/queries/#deleteone) query
+        Provide search criteria to the [DeleteOne](query.md#deleteone) query
         :param session: Optional[ClientSession] - PyMongo sessions
-        :return: [DeleteOne](https://roman-right.github.io/beanie/api/queries/#deleteone) query
+        :return: [DeleteOne](query.md#deleteone) query
         """
         # We need to cast here to tell mypy that we are sure about the type.
         # This is because delete may also return a DeleteOne type in general, and mypy can not be sure in this case

beanie/odm/queries/update.py

@@ -44,11 +44,6 @@ class UpdateResponse(str, Enum):
 class UpdateQuery(UpdateMethods, SessionMethods, CloneInterface):
     """
     Update Query base class
-
-    Inherited from:
-
-    - [SessionMethods](https://roman-right.github.io/beanie/api/interfaces/#sessionmethods)
-    - [UpdateMethods](https://roman-right.github.io/beanie/api/interfaces/#aggregatemethods)
     """
 
     def __init__(
@@ -109,10 +104,6 @@ async def _update(self) -> UpdateResult:
 class UpdateMany(UpdateQuery):
     """
     Update Many query class
-
-    Inherited from:
-
-    - [UpdateQuery](https://roman-right.github.io/beanie/api/queries/#updatequery)
     """
 
     def update(
@@ -229,10 +220,6 @@ def __await__(
 class UpdateOne(UpdateQuery):
     """
     Update One query class
-
-    Inherited from:
-
-    - [UpdateQuery](https://roman-right.github.io/beanie/api/queries/#updatequery)
     """
 
     def __init__(self, *args, **kwargs):

docs/tutorial/aggregate.md

@@ -12,7 +12,7 @@ avg_price = await Product.find(
 avg_price = await Product.avg(Product.price)
 ```
 
-A full list of available methods can be found [here](/api-documentation/interfaces/#aggregatemethods).
+A full list of available methods can be found [here](../api-documentation/interfaces.md/#aggregatemethods).
 
 You can also use the native PyMongo syntax by calling the `aggregate` method. 
 However, as Beanie will not know what output to expect, you will have to supply a projection model yourself. 

docs/tutorial/defining-a-document.md

@@ -47,7 +47,7 @@ It uses all the same patterns of `BaseModel`. But also it has special types of f
 
 `id` field of the `Document` class reflects the unique `_id` field of the MongoDB document. 
 Each object of the `Document` type has this field. 
-The default type of this is [PydanticObjectId](/api-documentation/fields/#pydanticobjectid).
+The default type of this is [PydanticObjectId](../api-documentation/fields.md/#pydanticobjectid).
 
 ```python
 class Sample(Document):

docs/tutorial/find.md

@@ -53,7 +53,7 @@ products = await Product.find(
 ).to_list()
 ```
 
-The whole list of the find query operators can be found [here](/api-documentation/operators/find).
+The whole list of the find query operators can be found [here](../api-documentation/operators/find.md).
 
 For more complex cases native PyMongo syntax is also supported:
 
@@ -64,14 +64,14 @@ products = await Product.find({"price": 1000}).to_list()
 ## Finding single documents
 
 Sometimes you will only need to find a single document. 
-If you are searching by `id`, then you can use the [get](/api-documentation/document/#documentget) method:
+If you are searching by `id`, then you can use the [get](../api-documentation/document.md/#documentget) method:
 
 ```python
 bar = await Product.get("608da169eb9e17281f0ab2ff")
 ```
 
 To find a single document via a single search criterion,
-you can use the [find_one](/api-documentation/interfaces/#findinterfacefind_one) method:
+you can use the [find_one](../api-documentation/interfaces.md/#findinterfacefind_one) method:
 
 ```python
 bar = await Product.find_one(Product.name == "Peanut Bar")
@@ -102,7 +102,7 @@ chocolates = await Product
 
 ### Sorting
 
-Sorting can be done with the [sort](/api-documentation/query#sort) method.
+Sorting can be done with the [sort](../api-documentation/query.md/#findmanysort) method.
 
 You can pass it one or multiple fields to sort by. You may optionally specify a `+` or `-` 
 (denoting ascending and descending respectively).

docs/tutorial/update.md

@@ -49,7 +49,7 @@ More complex update operations can be performed by calling `update()` with an up
 await Product.find_one(Product.name == "Tony's").update(Set({Product.price: 3.33}))
 ```
 
-The whole list of the update query operators can be found [here](/api-documentation/operators/update).
+The whole list of the update query operators can be found [here](../api-documentation/operators/update.md).
 
 Native MongoDB syntax is also supported:
 

pydoc-markdown.yml

@@ -16,7 +16,7 @@ renderer:
   output_directory: docs/build
   mkdocs_config:
     site_name: Beanie Documentation
-    site_url: https://roman-right.github.io/beanie/
+    site_url: https://beanie-odm.dev/
     theme:
       name: material
       palette:

pyproject.toml

@@ -51,7 +51,7 @@ doc = [
 queue = ["beanie-batteries-queue>=0.2"]
 
 [project.urls]
-homepage = "https://roman-right.github.io/beanie/"
+homepage = "https://beanie-odm.dev"
 repository = "https://github.com/roman-right/beanie"
 
 [project.scripts]
@@ -144,4 +144,4 @@ target-version = "py310"
 
 [tool.ruff.mccabe]
 # Unlike Flake8, default to a complexity level of 10.
-max-complexity = 10
+max-complexity = 10