Skip to content

Commit 88aa99d

Browse files
committed
doc: remove unhelpful CLI-related modules
1 parent d0146fc commit 88aa99d

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

  • {{ cookiecutter.pypi_package_name }}/doc/sphinx

{{ cookiecutter.pypi_package_name }}/doc/sphinx/conf.py

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,11 @@ def skip_module(app, what, name, obj, skip, options):
4646
if what != 'module':
4747
return skip
4848
if name in [
49+
{% if cookiecutter.include_executable == "y" -%}
50+
'{{ cookiecutter.python_package_name }}.__main__',
51+
'{{ cookiecutter.python_package_name }}.cli',
52+
'{{ cookiecutter.python_package_name }}.fire_workarounds',
53+
{% endif -%}
4954
'{{ cookiecutter.python_package_name }}.version',
5055
'{{ cookiecutter.python_package_name }}.settings',
5156
]:
@@ -58,7 +63,15 @@ def setup(sphinx):
5863

5964

6065
templates_path = []
61-
exclude_patterns = []
66+
exclude_patterns = [
67+
{% if cookiecutter.include_executable == "y" -%}
68+
'**/{{ cookiecutter.python_package_name }}/__main__/**',
69+
'**/{{ cookiecutter.python_package_name }}/cli/**',
70+
'**/{{ cookiecutter.python_package_name }}/fire_workarounds/**',
71+
{% endif -%}
72+
'**/{{ cookiecutter.python_package_name }}/version/**',
73+
'**/{{ cookiecutter.python_package_name }}/settings/**',
74+
]
6275

6376
# Man page output
6477

0 commit comments

Comments
 (0)