docs: Move to gp-libs (our internal helpers for sphinx, #812)

- Render changelog in [`linkify_issues`] 
- Fix Table of contents rendering with sphinx autodoc with [`sphinx_toctree_autodoc_fix`]
- Deprecate `sphinx-autoapi`, per above fixing the table of contents issue

  This also removes the need to workaround autoapi bugs.
- Test doctests in our docs via [`pytest_doctest_docutils`] (built on [`doctest_docutils`])

[`linkify_issues`]: https://gp-libs.git-pull.com/linkify_issues/
[`sphinx_toctree_autodoc_fix`]: https://gp-libs.git-pull.com/sphinx_toctree_autodoc_fix/
[`pytest_doctest_docutils`]: https://gp-libs.git-pull.com/doctest/pytest.html
[`doctest_docutils`]: https://gp-libs.git-pull.com/doctest

Author: tony

CHANGES

@@ -19,6 +19,17 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
 
 - _Insert changes/features/fixes for next release here_
 
+### Documentation
+
+- Render changelog in [`linkify_issues`] (#812)
+- Fix Table of contents rendering with sphinx autodoc with [`sphinx_toctree_autodoc_fix`] (#812)
+- Test doctests in our docs via [`pytest_doctest_docutils`] (built on [`doctest_docutils`]) (#812)
+
+[`linkify_issues`]: https://gp-libs.git-pull.com/linkify_issues/
+[`sphinx_toctree_autodoc_fix`]: https://gp-libs.git-pull.com/sphinx_toctree_autodoc_fix/
+[`pytest_doctest_docutils`]: https://gp-libs.git-pull.com/doctest/pytest.html
+[`doctest_docutils`]: https://gp-libs.git-pull.com/doctest
+
 ## tmuxp 1.13.3 (2022-09-10)
 
 - Revert v1.13.1's #793 change for now, the behavior behind launching workspace

docs/cli/convert.md

@@ -1,4 +1,4 @@
-(convert-config)=
+(cli-convert)=
 
 # tmuxp convert
 

docs/cli/load.md

@@ -8,7 +8,7 @@ You can load your tmuxp file and attach the vim session via a few
 shorthands:
 
 1. The directory with a `.tmuxp.{yaml,yml,json}` file in it
-2. The name of the project file in your {}`$HOME/.tmuxp` folder
+2. The name of the project file in your `$HOME/.tmuxp` folder
 3. The direct path of the tmuxp file you want to load
 
 Path to folder with `.tmuxp.yaml`, `.tmuxp.yml`, `.tmuxp.json`:

docs/conf.py

@@ -27,16 +27,22 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.linkcode",
     "aafig",
-    "sphinx_autoissues",
     "sphinx_click.ext",  # sphinx-click
     "sphinx_inline_tabs",
     "sphinx_copybutton",
     "sphinxext.opengraph",
     "sphinxext.rediraffe",
     "myst_parser",
+    "sphinx_toctree_autodoc_fix",
+    "linkify_issues",
 ]
 
-myst_enable_extensions = ["colon_fence", "substitution", "replacements"]
+myst_enable_extensions = [
+    "colon_fence",
+    "substitution",
+    "replacements",
+    "strikethrough",
+]
 
 templates_path = ["_templates"]
 
@@ -88,9 +94,8 @@
     ]
 }
 
-# sphinx-autoissues
-issuetracker = "github"
-issuetracker_project = about["__github__"].replace("https://github.com/", "")
+# linkify_issues
+issue_url_tpl = "https://github.com/tmux-python/tmuxp/issues/{issue_id}"
 
 # sphinxext.opengraph
 ogp_site_url = about["__docs__"]

poetry.lock

@@ -57,14 +57,14 @@ sphinx = "*"
 aafigure = ">=0.6"
 pillow = "*"
 furo = "*"
+gp-libs = "0.0.1a10"
 sphinx-autobuild = "*"
 sphinx-autodoc-typehints = "*"
 sphinx-click = "*"
 sphinx-inline-tabs = "*"
 sphinxext-opengraph = "*"
 sphinx-copybutton = "*"
 sphinxext-rediraffe = "*"
-sphinx-autoissues = "*"
 myst_parser = "*"
 docutils = "~0.18.0"
 
@@ -102,9 +102,9 @@ docs = [
   "sphinxext-opengraph",
   "sphinx-inline-tabs",
   "sphinxext-rediraffe",
-  "sphinx-autoissues",
   "myst_parser",
   "furo",
+  "gp-libs",
   "aafigure",
   "pillow",
 ]