Skip to content

Commit

Permalink
doc: exclude stubs
Browse files Browse the repository at this point in the history
  • Loading branch information
claui committed Dec 8, 2024
1 parent b53f933 commit 945d732
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions doc/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,18 @@ def skip_module(app, what, name, obj, skip, options):
if what == 'method':
return skip or name.endswith('.__str__')
if what == 'module':
return skip or name in [
'itchcraft.__main__',
'itchcraft.cli',
'itchcraft.fire_workarounds',
'itchcraft.version',
'itchcraft.settings',
]
return (
skip
or name
in [
'itchcraft.__main__',
'itchcraft.cli',
'itchcraft.fire_workarounds',
'itchcraft.version',
'itchcraft.settings',
]
or obj.obj['relative_path'].startswith('itchcraft/stubs')
)
return skip


Expand All @@ -77,6 +82,7 @@ def setup(sphinx):
'**/itchcraft/fire_workarounds/**',
'**/itchcraft/version/**',
'**/itchcraft/settings/**',
'**/itchcraft/stubs/**',
]

# Man page output
Expand Down

0 comments on commit 945d732

Please sign in to comment.