Skip to content

Commit f2eeb57

Browse files
committed
docs: Move to gp-lib modules
Remove sphinx-autoapi, which has broken imports. The only purpose this module had was showing table of contents. The tradeoff was a lot of difficult to track, subtle bugs. Also move to linkify_issues. A much simpler and more concise issue linker.
1 parent 300ff44 commit f2eeb57

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/conf.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,14 @@
2727
"sphinx.ext.napoleon",
2828
"sphinx.ext.linkcode",
2929
"aafig",
30-
"sphinx_autoissues",
3130
"sphinx_click.ext", # sphinx-click
3231
"sphinx_inline_tabs",
3332
"sphinx_copybutton",
3433
"sphinxext.opengraph",
3534
"sphinxext.rediraffe",
3635
"myst_parser",
36+
"sphinx_toctree_autodoc_fix",
37+
"linkify_issues",
3738
]
3839

3940
myst_enable_extensions = ["colon_fence", "substitution", "replacements"]
@@ -88,9 +89,8 @@
8889
]
8990
}
9091

91-
# sphinx-autoissues
92-
issuetracker = "github"
93-
issuetracker_project = about["__github__"].replace("https://github.com/", "")
92+
# linkify_issues
93+
issue_url_tpl = "https://github.com/tmux-python/tmuxp/issues/{issue_id}"
9494

9595
# sphinxext.opengraph
9696
ogp_site_url = about["__docs__"]

0 commit comments

Comments
 (0)