Update Sphinx configuration to exclude imported members and adjust me…

…mber order; remove GitHubClient class documentation
SCT-Engineering · May 1, 2025 · 3f587ea · 3f587ea
1 parent 1cfdb1f
commit 3f587ea
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 8 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -21,8 +21,13 @@
     'undoc-members': True,
     'show-inheritance': True,
     'special-members': '__init__',
+    'imported-members': False,  # Don't document imported members
 }
 
+# Don't document imported members in app module
+autodoc_mock_imports = ['github']
+autodoc_member_order = 'bysource'
+
 # Napoleon settings for Google-style docstrings
 napoleon_google_docstring = True
 napoleon_numpy_docstring = False

diff --git a/docs/source/modules/github_client.rst b/docs/source/modules/github_client.rst
@@ -5,12 +5,4 @@ GitHub Client
    :members:
    :undoc-members:
    :show-inheritance:
-
-GitHubClient Class
-----------------
-
-.. autoclass:: template_automation.app.GitHubClient
-   :members:
-   :undoc-members:
-   :show-inheritance:
    :special-members: __init__