Merge pull request #334 from yezyilomo/update-docs

Update docs

Author: yezyilomo

docs/extra.css

@@ -1,19 +1,28 @@
-.md-header{
+.md-header {
     height: 53px;
     padding-top: 2px;
 }
 
-.md-search__form input{
-    border-radius: 3px;
+.md-search__form,
+.md-search__output {
+    border-radius: 8px !important;
 }
 
-.md-source__icon svg{
+.md-search__output {
+    margin-top: 3px !important;
+}
+
+.md-source__icon svg {
     display: none;
 }
 
-.md-source__icon{
+.md-source__icon {
     background-image: url("img/github.svg");
     background-repeat: no-repeat;
     background-position: 50% center;
     background-size: 22px;
+}
+
+.md-code__content, .note{
+    border-radius: 10px !important;
 }

docs/mutating_data.md

@@ -87,7 +87,6 @@ Just to clarify what happed here:
 
 !!! note
     POST for many related fields supports two operations which are `create` and `add`.
-<br>
 
 Below we have an example where we are trying to update the property we have created in the previous example.
 
@@ -444,7 +443,6 @@ Request Body
 ```
 
 This will remove all books associated with a course being updated.
-<br>
 
 
 ### delete_on_null kwarg

docs/querying_data.md

@@ -113,7 +113,8 @@ If you want to retrieve user's `id`, `username` and `location` fields but under
     ...
 ]
 ```
-<br/>
+
+
 
 `GET /users/?query={id, username, groups{name}}`
 ```js
@@ -389,7 +390,6 @@ class CourseSerializer(DynamicFieldsMixin, serializers.ModelSerializer):
     }
 ]
 ```
-<br/>
 
 `GET /course/?query={name, related_books{title}}`
 ```js
@@ -403,7 +403,7 @@ class CourseSerializer(DynamicFieldsMixin, serializers.ModelSerializer):
     }
 ]
 ```
-<br/>
+
 
 ## DynamicFieldsMixin kwargs
 `DynamicFieldsMixin` accepts extra kwargs in addition to those accepted by a serializer, these extra kwargs can be used to do more customizations on a serializer as explained below.
@@ -494,19 +494,18 @@ From the response above you can see that `author` field has been excluded fom bo
 !!! note
     `fields` and `exclude` kwargs have no effect when you access the resources directly, so when you access books you will still get all fields i.e
 
-`GET /books/`
-```js
-[
-    {
-        "id": 1,
-        "title": "Computer Programming Basics",
-        "author": "S.Mobit"
-    },
-    ...
-]
-```
-So you can see that all fields have appeared as specified on `fields = ['id', 'title', 'author']` on BookSerializer class.
-<br/>
+    `GET /books/`
+    ```js
+    [
+        {
+            "id": 1,
+            "title": "Computer Programming Basics",
+            "author": "S.Mobit"
+        },
+        ...
+    ]
+    ```
+    Yo you can see that all fields have appeared as specified on `fields = ['id', 'title', 'author']` on BookSerializer class.
 
 
 ### query kwarg
@@ -645,7 +644,6 @@ class CourseSerializer(DynamicFieldsMixin, serializers.ModelSerializer):
 ]
 ```
 So you can see that on a nested field `books` pks have been returned instead of books data as specified on `return_pk=True` kwarg on `BookSerializer`.
-<br/>
 
 
 ### disable_dynamic_fields kwarg
@@ -686,7 +684,6 @@ class CourseSerializer(DynamicFieldsMixin, serializers.ModelSerializer):
 ]
 ```
 So you can see that even though the query asked for only `title` field under `books`, all fields have been returned, so this means fields filtering has applied on `CourseSerializer` but not on `BookSerializer` because we used `disable_dynamic_fields=True` on it.
-<br/>
 
 
 ## Query arguments

mkdocs.yml

@@ -3,8 +3,8 @@ site_name: Django RESTQL
 theme:
   name: "material"
   language: en
-  feature:
-    tabs: false
+  features:
+    - content.code.copy
   palette:
     primary: teal
     accent: teal
@@ -19,12 +19,18 @@ repo_url: https://github.com/yezyilomo/django-restql/
 
 # Extensions
 markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
   - admonition
-  - codehilite:
-      guess_lang: false
   - toc:
       permalink: true
 
+
 nav:
   - Intro: index.md
   - Querying Data: querying_data.md