docs: use intersphinx

This commit is contained in:
Anna “CyberTailor” 2024-01-07 21:47:47 +05:00
parent 85cc9de4d9
commit 8a7fa043df
Signed by: CyberTaIlor
GPG Key ID: E7B76EDC50864BB1
3 changed files with 11 additions and 2 deletions

View File

@ -23,7 +23,10 @@ emerge dev-util/find-work
### Other systems
`pip install find-work --user`
```sh
pip install find-work --user
sudo make install-data
```
Packaging

View File

@ -18,6 +18,7 @@ release = '0.1.0'
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'sphinx.ext.intersphinx',
'sphinx_prompt',
]
@ -43,6 +44,11 @@ templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
manpages_url = 'https://docs.sysrq.in/{path}'
intersphinx_mapping = {
'aiohttp': ('https://docs.aiohttp.org/en/stable', None),
'click': ('https://click.palletsprojects.com/en/latest', None),
}
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

View File

@ -20,7 +20,7 @@ from find_work.constants import PACKAGE, USER_AGENT
@asynccontextmanager
async def aiohttp_session() -> AsyncGenerator[aiohttp.ClientSession, None]:
"""
Construct an :external+aiohttp:py:class:`aiohttp.ClientSession` object.
Construct an :py:class:`aiohttp.ClientSession` object.
"""
headers = {"user-agent": USER_AGENT}