arcanis/ahriman
1
0
Fork 0
mirror of https://github.com/arcan1s/ahriman.git synced 2025-09-18 06:39:55 +00:00
Code Issues Projects Releases Wiki Activity

Docs update (#61)

Browse Source 
* Improve sphinx documentation

* update faq formatting

* fix setup doc

* fix docs according to the generated htmls
This commit is contained in:
Evgenii Alekseev
2022-05-05 20:24:24 +03:00
committed by Evgeniy Alekseev
parent 304690e0d0
commit 33e9fea47c
89 changed files with 5471 additions and 5304 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/ahriman/web/views/service/add.py
View File

@ -37,11 +37,11 @@ class AddView(BaseView):
"""
add new package
JSON body must be supplied, the following model is used:
JSON body must be supplied, the following model is used::
>>> {
>>> "packages": "ahriman" # either list of packages or package name as in AUR
>>> }
{
"packages": "ahriman" # either list of packages or package name as in AUR
}
Raises:
HTTPBadRequest: if bad data is supplied

8
src/ahriman/web/views/service/remove.py
View File

@ -37,11 +37,11 @@ class RemoveView(BaseView):
"""
remove existing packages
JSON body must be supplied, the following model is used:
JSON body must be supplied, the following model is used::
>>> {
>>> "packages": "ahriman", # either list of packages or package name
>>> }
{
"packages": "ahriman", # either list of packages or package name
}
Raises:
HTTPBadRequest: if bad data is supplied

8
src/ahriman/web/views/service/request.py
View File

@ -37,11 +37,11 @@ class RequestView(BaseView):
"""
request to add new package
JSON body must be supplied, the following model is used:
JSON body must be supplied, the following model is used::
>>> {
>>> "packages": "ahriman" # either list of packages or package name as in AUR
>>> }
{
"packages": "ahriman" # either list of packages or package name as in AUR
}
Raises:
HTTPBadRequest: if bad data is supplied

2
src/ahriman/web/views/service/search.py
View File

@ -41,7 +41,7 @@ class SearchView(BaseView):
"""
search packages in AUR
search string (non empty) must be supplied as `for` parameter
search string (non empty) must be supplied as ``for`` parameter
Returns:
Response: 200 with found package bases and descriptions sorted by base

8
src/ahriman/web/views/status/ahriman.py
View File

@ -50,11 +50,11 @@ class AhrimanView(BaseView):
"""
update service status
JSON body must be supplied, the following model is used:
JSON body must be supplied, the following model is used::
>>> {
>>> "status": "unknown", # service status string, must be valid `BuildStatusEnum`
>>> }
{
"status": "unknown", # service status string, must be valid ``BuildStatusEnum``
}
Raises:
HTTPBadRequest: if bad data is supplied

12
src/ahriman/web/views/status/package.py
View File

@ -81,13 +81,13 @@ class PackageView(BaseView):
"""
update package build status
JSON body must be supplied, the following model is used:
JSON body must be supplied, the following model is used::
>>> {
>>> "status": "unknown", # package build status string, must be valid `BuildStatusEnum`
>>> "package": {} # package body (use `dataclasses.asdict` to generate one), optional.
>>> # Must be supplied in case if package base is unknown
>>> }
{
"status": "unknown", # package build status string, must be valid ``BuildStatusEnum``
"package": {} # package body (use ``dataclasses.asdict`` to generate one), optional.
# Must be supplied in case if package base is unknown
}
Raises:
HTTPBadRequest: if bad data is supplied

10
src/ahriman/web/views/user/login.py
View File

@ -71,12 +71,12 @@ class LoginView(BaseView):
"""
login user to service
either JSON body or form data must be supplied the following fields are required:
either JSON body or form data must be supplied the following fields are required::
>>> {
>>> "username": "username" # username to use for login
>>> "password": "pa55w0rd" # password to use for login
>>> }
{
"username": "username", # username to use for login
"password": "pa55w0rd" # password to use for login
}
Raises:
HTTPFound: on success response