Skip to content

Commit ccee962

Browse files
committed
Added docs
1 parent d5dcd19 commit ccee962

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

docs/conf.py

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# SPDX-License-Identifier: LGPL-2.1-or-later
2+
3+
# Copyright (C) 2020, 2021 igo95862
4+
5+
# This file is part of python-sdbus
6+
7+
# This library is free software; you can redistribute it and/or
8+
# modify it under the terms of the GNU Lesser General Public
9+
# License as published by the Free Software Foundation; either
10+
# version 2.1 of the License, or (at your option) any later version.
11+
12+
# This library is distributed in the hope that it will be useful,
13+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
# Lesser General Public License for more details.
16+
17+
# You should have received a copy of the GNU Lesser General Public
18+
# License along with this library; if not, write to the Free Software
19+
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
from __future__ import annotations
21+
22+
from os.path import abspath
23+
from sys import path
24+
25+
project = 'python-sdbus-notifications'
26+
author = 'igo95862'
27+
source_suffix = '.rst'
28+
extensions = ['sdbus.autodoc']
29+
30+
autoclass_content = 'both'
31+
autodoc_typehints = 'description'
32+
autodoc_member_order = 'bysource'
33+
34+
path.insert(0, abspath('..'))

docs/index.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Freedesktop Notifications binds for python-sdbus
2+
================================================
3+
4+
This package contains python-sdbus binds for
5+
`Freedesktop notifications standard <https://specifications.freedesktop.org/notification-spec/notification-spec-latest.html>`_.
6+
7+
.. py:currentmodule:: sdbus_async.notifications
8+
9+
:py:class:`FreedesktopNotifications` is the proxy automatically connects.
10+
11+
:py:class:`NotificationsInterface` is the interface definition class if you want
12+
to implement your own notification daemon.
13+
14+
.. autoclass:: NotificationsInterface
15+
:members:
16+
17+
.. autoclass:: FreedesktopNotifications

0 commit comments

Comments
 (0)