Skip to content

Commit

Permalink
Fix doc build
Browse files Browse the repository at this point in the history
  • Loading branch information
abhinavsingh committed Nov 22, 2021
1 parent d96d5c2 commit 2805841
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
14 changes: 11 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,7 @@

nitpicky = True
_any_role = 'any'
_py_obj_role = 'py:obj'
_py_class_role = 'py:class'
nitpick_ignore = [
(_any_role, '<proxy.HttpProxyBasePlugin>'),
Expand All @@ -256,8 +257,10 @@
(_any_role, 'HttpParser.state'),
(_any_role, 'HttpProtocolHandler'),
(_any_role, 'multiprocessing.Manager'),
(_any_role, 'work_klass'),
(_any_role, 'proxy.core.base.tcp_upstream.TcpUpstreamConnectionHandler'),
(_any_role, 'work_klass'),
(_py_class_role, '_asyncio.Task'),
(_py_class_role, 'asyncio.events.AbstractEventLoop'),
(_py_class_role, 'CacheStore'),
(_py_class_role, 'HttpParser'),
(_py_class_role, 'HttpProtocolHandlerPlugin'),
Expand All @@ -268,12 +271,17 @@
(_py_class_role, 'paramiko.channel.Channel'),
(_py_class_role, 'proxy.http.parser.parser.T'),
(_py_class_role, 'proxy.plugin.cache.store.base.CacheStore'),
(_py_class_role, 'proxy.core.pool.AcceptorPool'),
(_py_class_role, 'proxy.core.executors.ThreadlessPool'),
(_py_class_role, 'proxy.core.acceptor.threadless.T'),

This comment has been minimized.

Copy link
@webknjaz

webknjaz Nov 22, 2021

Contributor

this entry is duplicated

This comment has been minimized.

Copy link
@abhinavsingh

abhinavsingh Nov 22, 2021

Author Owner

Yep it wanted me to add both py:obj and py:class roles, else it failed

(_py_class_role, 'queue.Queue[Any]'),
(_py_class_role, 'TcpClientConnection'),
(_py_class_role, 'TcpServerConnection'),
(_py_class_role, 'unittest.case.TestCase'),
(_py_class_role, 'unittest.result.TestResult'),
(_py_class_role, 'UUID'),
(_py_class_role, 'WebsocketFrame'),
(_py_class_role, 'Url'),
(_py_class_role, '_asyncio.Task'),
(_py_class_role, 'WebsocketFrame'),
(_py_class_role, 'Work'),
(_py_obj_role, 'proxy.core.acceptor.threadless.T'),
]
2 changes: 1 addition & 1 deletion proxy/core/acceptor/acceptor.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
from multiprocessing.reduction import recv_handle

from typing import List, Optional, Tuple
from typing import Any
from typing import Any # noqa: W0611 pylint: disable=unused-import

from ...common.flag import flags
from ...common.utils import is_threadless
Expand Down
4 changes: 2 additions & 2 deletions proxy/core/acceptor/threadless.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import selectors
import multiprocessing

from abc import abstractmethod, ABC, abstractproperty
from abc import abstractmethod, ABC
from typing import Dict, Optional, Tuple, List, Set, Generic, TypeVar, Union

from ...common.logger import Logger
Expand Down Expand Up @@ -87,8 +87,8 @@ def __init__(
] = {}
self.wait_timeout: float = DEFAULT_SELECTOR_SELECT_TIMEOUT

@abstractproperty
@property
@abstractmethod
def loop(self) -> Optional[asyncio.AbstractEventLoop]:
raise NotImplementedError()

Expand Down

0 comments on commit 2805841

Please sign in to comment.