Compare commits

...

3 commits

Author SHA1 Message Date
Izalia Mae c56926fc51 allow sphinx to link to barkshark-lib docs 2024-04-23 00:22:24 -04:00
Izalia Mae 9fd658b90c update docs 2024-04-23 00:17:38 -04:00
Izalia Mae 447d7a011f fix NameError in server 2024-04-23 00:11:22 -04:00
6 changed files with 5 additions and 36 deletions

4
dev.py
View file

@ -22,8 +22,8 @@ try:
except ImportError:
print("Installing missing dependencies...")
deps = " ".join(["build", "click", "watchfiles"])
subprocess.run(shlex.split(f"{sys.executable} -m pip install {deps}"))
deps = ["build", "click", "watchfiles"]
subprocess.run([sys.executable, "-m", "pip", "install", *deps])
print("Restarting script...")
subprocess.run([sys.executable, *sys.argv])

View file

@ -46,6 +46,7 @@ external_toc_exclude_missing = True
templates_path = ["templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
intersphinx_mapping = {
"blib": ("https://docs.barkshark.xyz/blib", None),
"python": (f"https://docs.python.org/{pyversion}", None)
}

View file

@ -47,12 +47,6 @@ Enums
:undoc-members:
:exclude-members: __new__
.. autoclass:: gemi.FileSizeUnit
:members:
:show-inheritance:
:undoc-members:
:exclude-members: __new__
.. autoclass:: gemi.OutputFormat
:members:
:show-inheritance:
@ -64,17 +58,3 @@ Enums
:show-inheritance:
:undoc-members:
:exclude-members: __new__
.. autoclass:: gemi.Enum
:members:
:show-inheritance:
.. autoclass:: gemi.IntEnum
:members:
:show-inheritance:
:exclude-members: __new__
.. autoclass:: gemi.StrEnum
:members:
:show-inheritance:
:exclude-members: __new__

View file

@ -1,23 +1,11 @@
Misc
====
.. autofunction:: gemi.convert_to_bytes
.. autofunction:: gemi.convert_to_string
.. autoclass:: gemi.BaseApp
:members:
:show-inheritance:
:exclude-members: __init__
.. autoclass:: gemi.AsyncTransport
:members:
:show-inheritance:
.. autoclass:: gemi.FileSize
:members:
:show-inheritance:
:exclude-members: __new__
.. autoclass:: gemi.Message
:members:
:show-inheritance:

View file

@ -47,7 +47,7 @@ Usage
import gemi
client = gemi.ClientServer()
client = gemi.AsyncClient()
def main():

View file

@ -11,6 +11,7 @@ import typing
from asyncio.exceptions import CancelledError
from blib import AsyncTransport
from pathlib import Path
from typing import Any
from .router import Router
@ -23,7 +24,6 @@ from ..misc import BaseApp
if typing.TYPE_CHECKING:
from asyncio import StreamReader, StreamWriter
from collections.abc import Callable
from typing import Any
from .router import RouteHandler