Skip to content

Commit

Permalink
🎨 improve docs with hovering
Browse files Browse the repository at this point in the history
  • Loading branch information
mraniki committed Aug 6, 2023
1 parent 30751a7 commit d2aede8
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 14 deletions.
20 changes: 7 additions & 13 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
"sphinx.ext.intersphinx",
"hoverxref.extension",
]


Expand All @@ -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'
Expand Down Expand Up @@ -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),
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down

0 comments on commit d2aede8

Please sign in to comment.