Started on docs

Author: igo95862

docs/conf.py

@@ -0,0 +1,32 @@
+# SPDX-License-Identifier: LGPL-2.1-or-later
+
+# Copyright (C) 2020, 2021 igo95862
+
+# This file is part of python-sdbus
+
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
+from os.path import abspath
+from sys import path
+
+project = 'python-sdbus-networkmanager'
+author = 'igo95862'
+source_suffix = '.rst'
+extensions = ['sdbus.autodoc']
+
+autoclass_content = 'both'
+autodoc_typehints = 'description'
+autodoc_member_order = 'bysource'
+
+path.insert(0, abspath('..'))

docs/device_interfaces.rst

@@ -0,0 +1,7 @@
+Devices interfaces
+==================
+
+Contains interfaces for most types of devices.
+
+.. autoclass:: sdbus_async.networkmanager.NetworkManagerDeviceWiredInterfaceAsync
+    :members:

docs/index.rst

@@ -0,0 +1,16 @@
+Network Manager binds for python-sdbus
+======================================
+
+This package contains python-sdbus for D-Bus interface
+of `NetworkManager <https://wiki.gnome.org/Projects/NetworkManager>`_.
+
+.. toctree::
+    :maxdepth: 3
+    :caption: Contents:
+
+    objects
+    device_interfaces
+    other_interfaces
+
+See `python-sdbus <https://github.com/igo95862/python-sdbus>`_ homepage if you are
+unfamiliar with python-sdbus.

docs/objects.rst

@@ -0,0 +1,14 @@
+Network Manager objects
+=======================
+
+All objects avaiable in NetworkManager.
+
+Only the implemented interfaces for each object
+are documented. Click on interface link to see
+which properties and methods does the interface implements.
+
+Network Manager main object
+---------------------------
+
+.. autoclass:: sdbus_async.networkmanager.NetworkManager
+    :members:

docs/other_interfaces.rst

@@ -0,0 +1,7 @@
+Other interfaces
+============================
+
+Not device interfaces implemented by NetworkManager.
+
+.. autoclass:: sdbus_async.networkmanager.NetworkManagerInterfaceAsync
+    :members: