Skip to content

Commit c82f452

Browse files
⚡🔨📚 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
1 parent c5fadd4 commit c82f452

File tree

5 files changed

+10
-4
lines changed

5 files changed

+10
-4
lines changed

docs/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,6 @@ Here are some additional resources that might be helpful:
154154
- `pylint Documentation <https://pylint.pycqa.org/en/latest/>`_
155155
- `Pre-commit Documentation <https://pre-commit.com/>`_
156156

157-
---
157+
----
158158

159159
Thank you for your interest in contributing to `django_logging`! We look forward to your contributions.

docs/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ Welcome to django_logging Documentation!
1717
:target: https://django-logging.readthedocs.io/en/latest/
1818
:alt: Documentation
1919

20+
.. image:: https://img.shields.io/badge/pylint-10/10-brightgreen?logo=python&logoColor=blue
21+
:target: https://www.pylint.org/
22+
:alt: Pylint
23+
2024
.. image:: https://img.shields.io/pypi/pyversions/dj-logging
2125
:target: https://pypi.org/project/dj-logging/
2226
:alt: Supported Python versions

docs/quick_start.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ By default, django_logging will log each level to its own file:
5353

5454
In addition, logs will be displayed in **colorized** mode in the `console`, making it easier to distinguish between different log levels.
5555

56-
That's it! `django_logging` is ready to use. For further customization, refer to the Settings section.
56+
That's it! `django_logging` is ready to use. For further customization, refer to the :doc:`Settings <settings>`.

docs/settings.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Here's a breakdown of the available configuration options:
4747

4848
- **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.
4949

50-
- **Note**:See the **Available Format Options** below for available formats.
50+
- **Note**:See the `Available Format Options`_ below for available formats.
5151

5252
- **LOG_CONSOLE_LEVEL**: Accepts `str` that is a valid log level. Specifies the log level for console output. Defaults to `'DEBUG'`,
5353

@@ -70,6 +70,8 @@ Here's a breakdown of the available configuration options:
7070
- **USE_TEMPLATE**: Accepts `bool`. Determines whether the email includes an HTML template. Defaults to `True`.
7171

7272

73+
.. _available_format_options:
74+
7375
Available Format Options
7476
------------------------
7577

docs/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Log and Notify Utility
107107
"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."
108108
109109
Additionally, ensure that all required email settings are configured in your Django settings file.
110-
- **Note**: For more detailed configuration options, refer to the [Settings](settings.rst) section.
110+
- **Note**: For more detailed configuration options, refer to the :doc:`Settings <settings>`.
111111

112112
Send Logs Command
113113
-----------------

0 commit comments

Comments
 (0)