From d2aede8e6077a388e5c7a86a3392ad3a5312978e Mon Sep 17 00:00:00 2001 From: mraniki <8766259+mraniki@users.noreply.github.com> Date: Sun, 6 Aug 2023 16:33:41 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=A8=20improve=20docs=20with=20hovering?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/conf.py | 20 +++++++------------- pyproject.toml | 2 +- 2 files changed, 8 insertions(+), 14 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index bd470994..ad72b42a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,6 +23,7 @@ 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', "sphinx.ext.intersphinx", + "hoverxref.extension", ] @@ -44,7 +45,12 @@ } intersphinx_disabled_reftypes = ["*"] - +hoverxref_auto_ref = True +hoverxref_intersphinx = [ + 'readthedocs', + 'sphinx', + 'python', +] napoleon_google_docstring = True autosummary_generate = True autoclass_content = 'both' @@ -87,18 +93,6 @@ 'navbar_links': [ ("TalkyTrader", "https://talkytrader.github.io/wiki/",True), - ("_menu", "🗿 Talky",[ - ("🪙 Get started", "https://talky.rtfd.io/01_start",True), - ("⚙️ Config", "https://talky.rtfd.io/02_config",True), - ]), - ("_menu", "🔌 Plugins",[ - ("👂 IamListening", "https://iamlistening.rtfd.io/", True), - ("🔎 FindMyOrder", "https://findmyorder.rtfd.io/", True), - ("⛓️ DXSP", "https://dxsp.rtfd.io/", True), - ("💱 CEX", "index",True), - ("💁 Helper", "index",True), - ("📰 Talkytrend", "https://talkytrend.rtfd.io/", True), - ]), ("_menu", "➕ More",[ ("🆕 What's new?", "https://github.com/mraniki/tt",True), ("💬 Connect", "https://talky.rtfd.io",True), diff --git a/pyproject.toml b/pyproject.toml index c91e4b7d..ade3c55a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -69,7 +69,7 @@ optional = true [tool.poetry.group.docs.dependencies] sphinx = ">=5,<6" sphinx_bootstrap_theme = "^0.8.1" -sphinxext-remoteliteralinclude = "^0.4.0" +sphinx-hoverxref = "^1.3.0" [tool.pytest.ini_options]