Skip to content

Commit 664b9ed

Browse files
committed
docs: Integrate README with pydoc site
1 parent a0c344f commit 664b9ed

2 files changed

Lines changed: 10 additions & 12 deletions

File tree

README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# victorialogs-handler
22

3-
A Python log handler for VictoriaLogs.
3+
A high-performance Python log handler for VictoriaLogs.
44

55
[![release](https://img.shields.io/pypi/v/python-victorialogs-handler?label=release)](https://pypi.org/project/python-victorialogs-handler/)
66
[![python](https://img.shields.io/pypi/pyversions/python-victorialogs-handler)](https://pypi.org/project/python-victorialogs-handler/)
@@ -9,14 +9,7 @@ A Python log handler for VictoriaLogs.
99
[![license](https://img.shields.io/badge/license-MIT-green)](https://gitlab.com/ErikKalkoken/python-victorialogs-handler/-/blob/master/LICENSE)
1010

1111
> [!IMPORTANT]
12-
> STATUS: In development. The API is not yet stable.
13-
14-
## Content
15-
16-
- [Description](#description)
17-
- [Installation](#installation)
18-
- [Quick Start](#quick-start)
19-
- [Documentation](#documentation)
12+
> STATUS: In development. The API may still change.
2013
2114
## Description
2215

@@ -66,4 +59,4 @@ Please see the directory `/examples` for additional examples on how to use the h
6659

6760
## Documentation
6861

69-
For a description of how the handler works and the API documentation - which also includes the configuration options - please see the [Documentation](https://erikkalkoken.github.io/python-victorialogs-handler/).
62+
The full documentation can be found here: [Documentation](https://erikkalkoken.github.io/python-victorialogs-handler/).

src/vlogs_handler/__init__.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
1-
"""A log handler for VictoriaLogs.
1+
"""
2+
This is the documentation for the VictoriaLogs Handler.
23
4+
# Readme
5+
.. include:: ../../README.md
6+
:start-line: 2
7+
:end-line: 59
38
.. include:: technical.md
49
"""
510

611
from .handler import VictoriaLogsHandler # noqa: F401
712

813
__title__ = "VictoriaLogs Handler"
9-
__version__ = "0.1.0dev8"
14+
__version__ = "0.1.0a1"
1015

1116
__all__ = ["VictoriaLogsHandler"]

0 commit comments

Comments
 (0)