⚡🔨📚 refactor(docs): update badges and refrences in rst docs

- Added pylint badge to the documentation - Updated the settings section in various .rst files to reflect recent changes - Enhanced documentation for better readability and accuracy
Lazarus-org · Sep 5, 2024 · c82f452 · c82f452
1 parent c5fadd4
commit c82f452
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 4 deletions.
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -154,6 +154,6 @@ Here are some additional resources that might be helpful:
 - `pylint Documentation <https://pylint.pycqa.org/en/latest/>`_
 - `Pre-commit Documentation <https://pre-commit.com/>`_
 
----
+----
 
 Thank you for your interest in contributing to `django_logging`! We look forward to your contributions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -17,6 +17,10 @@ Welcome to django_logging Documentation!
     :target: https://django-logging.readthedocs.io/en/latest/
     :alt: Documentation
 
+.. image:: https://img.shields.io/badge/pylint-10/10-brightgreen?logo=python&logoColor=blue
+   :target: https://www.pylint.org/
+   :alt: Pylint
+
 .. image:: https://img.shields.io/pypi/pyversions/dj-logging
     :target: https://pypi.org/project/dj-logging/
     :alt: Supported Python versions

diff --git a/docs/quick_start.rst b/docs/quick_start.rst
@@ -53,4 +53,4 @@ By default, django_logging will log each level to its own file:
 
 In addition, logs will be displayed in **colorized** mode in the `console`, making it easier to distinguish between different log levels.
 
-That's it! `django_logging` is ready to use. For further customization, refer to the Settings section.
+That's it! `django_logging` is ready to use. For further customization, refer to the :doc:`Settings <settings>`.
diff --git a/docs/settings.rst b/docs/settings.rst
@@ -47,7 +47,7 @@ Here's a breakdown of the available configuration options:
 
 - **LOG_FILE_FORMATS**: Accepts log levels as keys and format options as values. The format option can be an `int` chosen from predefined options or a user-defined format `str`. Defines the format for log files. Defaults to `1` for all levels.
 
- - **Note**:See the **Available Format Options** below for available formats.
+ - **Note**:See the `Available Format Options`_ below for available formats.
 
 - **LOG_CONSOLE_LEVEL**: Accepts `str` that is a valid log level. Specifies the log level for console output. Defaults to `'DEBUG'`,
 
@@ -70,6 +70,8 @@ Here's a breakdown of the available configuration options:
  - **USE_TEMPLATE**: Accepts `bool`. Determines whether the email includes an HTML template.  Defaults to `True`.
 
 
+.. _available_format_options:
+
 Available Format Options
 ------------------------
 

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -107,7 +107,7 @@ Log and Notify Utility
       "Email notifier is disabled. Please set the 'ENABLE' option to True in the 'LOG_EMAIL_NOTIFIER' in DJANGO_LOGGING in your settings to activate email notifications."
 
    Additionally, ensure that all required email settings are configured in your Django settings file.
-    - **Note**: For more detailed configuration options, refer to the [Settings](settings.rst) section.
+    - **Note**: For more detailed configuration options, refer to the :doc:`Settings <settings>`.
 
 Send Logs Command
 -----------------