|
37 | 37 |
|
38 | 38 | # Suppress specific warnings |
39 | 39 | suppress_warnings = [ |
40 | | - 'myst.header', # Suppress header level warnings from notebooks |
41 | | - 'toc.not_readable', # Suppress toctree warnings for symlinked files |
| 40 | + 'myst.header', # header level warnings from notebooks |
| 41 | + 'toc.not_readable', # toctree warnings for symlinked files |
| 42 | + 'ref.python', # "more than one target found" for duplicate class names |
| 43 | + 'autosummary', # autosummary import failures for internal modules |
42 | 44 | ] |
43 | 45 |
|
44 | 46 | html_theme = 'sphinx_book_theme' |
|
76 | 78 | 'members': True, |
77 | 79 | 'undoc-members': True, |
78 | 80 | 'show-inheritance': True, |
| 81 | + 'private-members': False, |
79 | 82 | } |
80 | 83 |
|
81 | | -# Generate autosummary stubs |
| 84 | +# Generate autosummary stubs recursively |
82 | 85 | autosummary_generate = True |
83 | 86 |
|
84 | | -# Don't mock imports - let them fail gracefully and show what's available |
85 | | -autodoc_mock_imports = [] |
| 87 | +# Suppress internal/implementation modules not intended for users |
| 88 | +exclude_patterns += [ |
| 89 | + '*/telemetry*', |
| 90 | + '*/tools*', |
| 91 | + '*/container_drivers*', |
| 92 | + '*/runtime_environment*', |
| 93 | + '*/model_server*', |
| 94 | + '*/detector*', |
| 95 | + '*/validations*', |
| 96 | + '*/image_retriever*', |
| 97 | +] |
| 98 | + |
| 99 | +# Modules that fail to import due to runtime dependencies or side effects |
| 100 | +autodoc_mock_imports = [ |
| 101 | + 'triton_python_backend_utils', |
| 102 | + 'sagemaker.serve.model_server.in_process_model_server.app', |
| 103 | + 'sagemaker.serve.model_server.multi_model_server.inference', |
| 104 | + 'sagemaker.serve.model_server.tensorflow_serving.inference', |
| 105 | + 'sagemaker.serve.model_server.torchserve.inference', |
| 106 | + 'sagemaker.serve.model_server.torchserve.xgboost_inference', |
| 107 | + 'sagemaker.serve.model_server.triton.model', |
| 108 | + # Heavy runtime dependencies — mock to avoid slow/failing imports during doc build |
| 109 | + 'boto3', |
| 110 | + 'botocore', |
| 111 | + 'torch', |
| 112 | + 'tensorflow', |
| 113 | + 'sklearn', |
| 114 | + 'numpy', |
| 115 | + 'pandas', |
| 116 | + 'scipy', |
| 117 | + 'xgboost', |
| 118 | + 'lightgbm', |
| 119 | + 'mlflow', |
| 120 | + 'pyspark', |
| 121 | + 'transformers', |
| 122 | + 'datasets', |
| 123 | + 'trl', |
| 124 | +] |
| 125 | + |
86 | 126 | suppress_warnings = ['autodoc.import_error'] |
| 127 | + |
| 128 | +# Speed up builds: only regenerate autosummary stubs if they don't exist |
| 129 | +autosummary_generate_overwrite = False |
0 commit comments