Skip to content

Commit 15f2259

Browse files
committed
chore(docs): update configuration to suppress warnings
1 parent c5bf1f5 commit 15f2259

2 files changed

Lines changed: 15 additions & 0 deletions

File tree

docs/conf.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,20 @@
6868
'sphinx_copybutton',
6969
]
7070

71+
# Only auto-generate section labels for the top two heading levels: deeper
72+
# subsections (e.g. the repeated "SHACL checks" / "Python checks" headings)
73+
# would otherwise produce duplicate-label warnings within the same document.
74+
autosectionlabel_maxdepth = 2
75+
76+
# Warnings raised while embedding the Markdown README into the Sphinx pages.
77+
# The README is the canonical GitHub document: its slices intentionally start
78+
# below H1 (myst.header) and use GitHub-relative anchor links that span pages
79+
# (myst.xref_missing). These are expected when including it here.
80+
suppress_warnings = [
81+
'myst.header',
82+
'myst.xref_missing',
83+
]
84+
7185
templates_path = ['_templates']
7286
# exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'experiments', 'ontologies', 'tests', 'logs', 'examples', 'debug']
7387
# List of patterns, relative to source directory, that match files and

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ enum-tools==0.12.0
55
sphinx-toolbox==3.8.1
66
myst-parser==4.0.0
77
sphinx_rtd_theme==3
8+
sphinx-copybutton==0.5.2

0 commit comments

Comments
 (0)