diff --git a/README.md b/README.md index df9bd18..7236ac5 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/conf.py b/docs/conf.py index 2463ed0..c33836b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 diff --git a/find_work/utils.py b/find_work/utils.py index 9ca3d8f..eb08006 100644 --- a/find_work/utils.py +++ b/find_work/utils.py @@ -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}