Documentation & adjustments (#48)

Documentation for API's and methods

---------

Signed-off-by: Alexander Piskun <[email protected]>

Author: bigcat88

.github/workflows/analysis-coverage.yml

@@ -13,7 +13,7 @@ on:
     branches: [main]
     paths:
       - '.github/workflows/analysis-coverage.yml'
-      - 'pillow_heif/*.*'
+      - 'nc_py_api/*.*'
       - 'tests/**'
       - 'setup.*'
       - 'pyproject.toml'

CHANGELOG.md

@@ -2,14 +2,18 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.0.26 - 2023-0x-xx]
+## [0.0.26 - 2023-07-xx]
 
 ### Added
 
-- First Examples.
 - More documentation.
 - First `Notifications` APIs.
 
+### Changed
+
+- Reworked `User Status API`
+- Reworked return type for `weather_status.get_location`
+
 ## [0.0.25 - 2023-07-25]
 
 ### Added

docs/Nextcloud.rst

@@ -0,0 +1,23 @@
+.. py:currentmodule:: nc_py_api.nextcloud
+
+Nextcloud
+=========
+
+The two main classes provided by the library for working with the Nextcloud.
+
+All required functionality is incorporated in them, they contains all other classes required to work with the Nextcloud.
+
+Client
+------
+
+.. autoclass:: Nextcloud
+    :inherited-members:
+    :members:
+
+
+Application
+-----------
+
+.. autoclass:: NextcloudApp
+    :inherited-members:
+    :members:

docs/Options.rst

@@ -0,0 +1,12 @@
+.. _options:
+
+``Currently, this section is `under construction` and will be changed in the near future.``
+
+Options
+-------
+
+.. autodata:: nc_py_api.options.XDEBUG_SESSION
+.. autodata:: nc_py_api.options.TIMEOUT
+.. autodata:: nc_py_api.options.TIMEOUT_DAV
+.. autodata:: nc_py_api.options.DAV_URL_SUFFIX
+.. autodata:: nc_py_api.options.VERIFY_NC_CERTIFICATE

docs/conf.py

@@ -57,6 +57,9 @@
 # Default is False. You can activate this mode temporarily using the -n command-line
 # switch.
 nitpicky = True
+nitpick_ignore_regex = [(r"py:class", r"starlette\.requests\.Request")]
+
+autodoc_member_order = "bysource"
 
 
 def setup(app):

docs/index.rst

@@ -27,6 +27,8 @@ Have a great time with Python and Nextcloud!
 .. toctree::
    :maxdepth: 1
 
+   Nextcloud
+   Options
    reference/index.rst
    benchmarks/AppEcosystem.rst
 

docs/reference/Apps.rst

@@ -0,0 +1,10 @@
+.. py:currentmodule:: nc_py_api.apps
+
+Applications Management API
+---------------------------
+
+.. autoclass:: AppAPI
+    :members:
+
+.. autoclass:: ExAppInfo
+    :members:

docs/reference/constants.rst renamed to docs/reference/Constants.rst

@@ -3,6 +3,12 @@
 Constants
 =========
 
+.. autoclass:: ApiScope
+    :members:
+
+.. autoclass:: LogLvl
+    :members:
+
 .. autoclass:: SharePermissions
     :members:
 

docs/reference/Exceptions.rst

@@ -0,0 +1,10 @@
+.. py:currentmodule:: nc_py_api.exceptions
+
+Exceptions
+==========
+
+.. autoclass:: NextcloudException
+    :members:
+
+.. autoclass:: NextcloudExceptionNotFound
+    :members:

docs/reference/Session.rst

@@ -1,7 +1,21 @@
+.. py:currentmodule:: nc_py_api._session
+
+Session Structures
+==================
+
+.. autoclass:: ServerVersion
+    :members:
+
+.. autoclass:: nc_py_api.theming.ThemingInfo
+    :members:
+
+.. autoclass:: AppConfig
+    :members:
+
 Sessions Internal
 =================
 
 Currently Session API is private, and not exposed.
 
-.. autoclass:: nc_py_api._session.NcSessionBasic
+.. autoclass:: NcSessionBasic
     :members: