docs: Move to gp-lib modules

tony · tony · commit 72db710f6418 · 2022-09-10T08:56:38.000-05:00
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.
diff --git a/docs/conf.py b/docs/conf.py
@@ -22,19 +22,19 @@
 
 extensions = [
     "sphinx.ext.autodoc",
-    "autoapi.extension",
     "sphinx.ext.intersphinx",
     "sphinx_autodoc_typehints",
     "sphinx.ext.todo",
     "sphinx.ext.linkcode",
     "sphinx.ext.napoleon",
-    "sphinx_autoissues",
     "sphinx_click.ext",  # sphinx-click
     "sphinx_inline_tabs",
     "sphinx_copybutton",
     "sphinxext.opengraph",
     "sphinxext.rediraffe",
     "myst_parser",
+    "linkify_issues",
+    "sphinx_toctree_autodoc_fix",
 ]
 
 myst_enable_extensions = [
@@ -94,21 +94,14 @@
     ]
 }
 
-# sphinx-autoissues
-issuetracker = "github"
-issuetracker_project = about["__github__"].replace("https://github.com/", "")
+# linkify_issues
+issue_url_tpl = f'{about["__github__"]}/issues/{{issue_id}}'
 
 # sphinx.ext.autodoc
 autoclass_content = "both"
 autodoc_member_order = "bysource"
 autosummary_generate = True
 
-# sphinx-autoapi
-autoapi_type = "python"
-autoapi_dirs = [project_root / "libtmux"]
-autoapi_generate_api_docs = False  # when fales, use directives
-suppress_warnings = ["autoapi.python_import_resolution", "autoapi.not_readable"]
-
 # sphinx-copybutton
 copybutton_prompt_text = (
     r">>> |\.\.\. |> |\$ |\# | In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
diff --git a/docs/internals/test.md b/docs/internals/test.md
@@ -1,6 +1,6 @@
 # Test helpers
 
 ```{eval-rst}
-.. autoapimodule:: libtmux.test
+.. automodule:: libtmux.test
    :members:
 ```
diff --git a/docs/pytest-plugin.md b/docs/pytest-plugin.md
@@ -87,12 +87,10 @@ object lookups in the test grid.
 ## API reference
 
 ```{eval-rst}
-.. autoapimodule:: libtmux.pytest_plugin
+.. automodule:: libtmux.pytest_plugin
     :members:
     :inherited-members:
     :private-members:
     :show-inheritance:
     :member-order: bysource
-    :exclude-members: Server, TEST_SESSION_PREFIX, get_test_session_name,
-        namer, logger
 ```
diff --git a/docs/reference/common.md b/docs/reference/common.md
@@ -1,6 +1,6 @@
 # Utilities
 
 ```{eval-rst}
-.. autoapimodule:: libtmux.common
+.. automodule:: libtmux.common
    :members:
 ```
diff --git a/docs/reference/exceptions.md b/docs/reference/exceptions.md
@@ -1,6 +1,6 @@
 # Exceptions
 
 ```{eval-rst}
-.. autoapimodule:: libtmux.exc
+.. automodule:: libtmux.exc
    :members:
 ```
diff --git a/docs/reference/panes.md b/docs/reference/panes.md
@@ -10,7 +10,7 @@
 [pty(4)]: https://www.freebsd.org/cgi/man.cgi?query=pty&sektion=4
 
 ```{eval-rst}
-.. autoapiclass:: libtmux.Pane
+.. autoclass:: libtmux.Pane
     :members:
     :inherited-members:
     :private-members:
diff --git a/docs/reference/servers.md b/docs/reference/servers.md
@@ -10,7 +10,7 @@
 tmux initializes a server on automatically on first running (e.g. executing `tmux`)
 
 ```{eval-rst}
-.. autoapiclass:: libtmux.Server
+.. autoclass:: libtmux.Server
     :members:
     :inherited-members:
     :private-members:
diff --git a/docs/reference/sessions.md b/docs/reference/sessions.md
@@ -7,7 +7,7 @@
 - Identified by `$`, e.g. `$313`
 
 ```{eval-rst}
-.. autoapiclass:: libtmux.Session
+.. autoclass:: libtmux.Session
     :members:
     :inherited-members:
     :private-members:
diff --git a/docs/reference/windows.md b/docs/reference/windows.md
@@ -11,7 +11,7 @@
 ```
 
 ```{eval-rst}
-.. autoapiclass:: Window
+.. autoclass:: Window
     :members:
     :inherited-members:
     :private-members:
