Skip to content

Commit f3c79f6

Browse files
committed
Update
1 parent 25221e7 commit f3c79f6

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/source/conf.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,17 +186,25 @@ def get_version_path():
186186
"docutils", # Suppress docstring formatting issues from third-party libraries
187187
"app.add_node", # Suppress node warnings
188188
"app.add_directive", # Suppress directive warnings
189+
"ref.class", # Suppress missing reference warnings
190+
"ref.func", # Suppress missing function reference warnings
191+
"ref.meth", # Suppress missing method reference warnings
189192
]
190193

191194
# Treat warnings as non-fatal - continue build even if there are warnings
192195
keep_warnings = True
193196

197+
# Don't fail the build on warnings - important for handling third-party library docstrings
198+
# This is especially important when dependencies (like torchtitan) have RST formatting
199+
# that may not be perfect but works with Napoleon extension
200+
nitpicky = False # Don't be overly strict about references
201+
194202
# Napoleon settings for Google-style docstrings (from torchtitan and other dependencies)
195203
napoleon_google_docstring = True
196204
napoleon_numpy_docstring = True
197205
napoleon_use_param = True
198206
napoleon_use_rtype = True
199-
napoleon_preprocess_types = False
207+
napoleon_use_ivar = True
200208

201209

202210
# -- Sphinx Gallery configuration -------------------------------------------

0 commit comments

Comments
 (0)