From 3f587ea78433c3ae42b1f0c53d9ec1d471df4c71 Mon Sep 17 00:00:00 2001 From: Dave Arnold Date: Thu, 1 May 2025 08:27:00 -0700 Subject: [PATCH] Update Sphinx configuration to exclude imported members and adjust member order; remove GitHubClient class documentation --- docs/source/conf.py | 5 +++++ docs/source/modules/github_client.rst | 8 -------- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 4869ad7..95510f0 100644 --- 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 index 3b5eb74..b735924 100644 --- 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__