mirrors/fdroidserver
1
0
Fork 0
mirror of https://github.com/f-droid/fdroidserver.git synced 2025-11-06 23:40:29 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

[docs] Start utilising intersphinx

Browse source
This commit is contained in:
Gregor Düster 2023-10-22 21:27:08 +02:00
parent f238470855
commit 02b855da5e
No known key found for this signature in database
GPG key ID: 1B4181FC97673B9D
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
fdroidserver/checkupdates.py
View file

@ -63,7 +63,7 @@ def check_http(app: metadata.App) -> tuple[Union[str, None], Union[int, None]]:
Raises Raises
------ ------
FDroidException :exc:`~fdroidserver.exception.FDroidException`
If UpdateCheckData is missing or is an invalid URL or if there is no If UpdateCheckData is missing or is an invalid URL or if there is no
match for the provided versionName or versionCode regex. match for the provided versionName or versionCode regex.
""" """
@ -133,10 +133,10 @@ def check_tags(app: metadata.App, pattern: str) -> tuple[str, int, str]:
Raises Raises
------ ------
MetaDataException :exc:`~fdroidserver.exception.MetaDataException`
If this function is not suitable for the RepoType of the app or If this function is not suitable for the RepoType of the app or
information is missing to perform this type of check. information is missing to perform this type of check.
FDroidException :exc:`~fdroidserver.exception.FDroidException`
If no matching tags or no information whatsoever could be found. If no matching tags or no information whatsoever could be found.
""" """
if app.RepoType == 'srclib': if app.RepoType == 'srclib':
@ -294,7 +294,7 @@ def check_repomanifest(app: metadata.App, branch: Optional[str] = None) -> tuple
Raises Raises
------ ------
FDroidException :exc:`~fdroidserver.exception.FDroidException`
If no package id or no version information could be found. If no package id or no version information could be found.
""" """
if app.RepoType == 'srclib': if app.RepoType == 'srclib':
@ -422,7 +422,7 @@ def dirs_with_manifest(startdir: str):
Yields Yields
------ ------
path : pathlib.Path or None path : :class:`pathlib.Path` or None
A directory that contains a manifest file of an Android project, None if A directory that contains a manifest file of an Android project, None if
no directory could be found no directory could be found
""" """
@ -444,7 +444,7 @@ def possible_subdirs(app: metadata.App):
Yields Yields
------ ------
subdir : pathlib.Path or None subdir : :class:`pathlib.Path` or None
A possible subdir, None if no subdir could be found A possible subdir, None if no subdir could be found
""" """
if app.RepoType == 'srclib': if app.RepoType == 'srclib':
@ -544,7 +544,7 @@ def operate_vercode(operation: str, vercode: int) -> int:
Raises Raises
------ ------
MetaDataException :exc:`~fdroidserver.exception.MetaDataException`
If the operation is invalid. If the operation is invalid.
""" """
if not common.VERCODE_OPERATION_RE.match(operation): if not common.VERCODE_OPERATION_RE.match(operation):
@ -570,9 +570,9 @@ def checkupdates_app(app: metadata.App) -> None:
Raises Raises
------ ------
MetaDataException :exc:`~fdroidserver.exception.MetaDataException`
If the app has an invalid UpdateCheckMode or AutoUpdateMode. If the app has an invalid UpdateCheckMode or AutoUpdateMode.
FDroidException :exc:`~fdroidserver.exception.FDroidException`
If no version information could be found, the current version is newer If no version information could be found, the current version is newer
than the found version, auto-update was requested but an app has no than the found version, auto-update was requested but an app has no
CurrentVersionCode or (Git) commiting the changes failed. CurrentVersionCode or (Git) commiting the changes failed.