Skip to content

Commit 0d671d2

Browse files
committed
Using sphinxcontrib.spelling as extension
1 parent d19fbca commit 0d671d2

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

.github/workflows/build-sphinx.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ jobs:
103103
- name: Install sphinx dependencies
104104
run: |
105105
conda install sphinx sphinx_rtd_theme
106-
pip install sphinxcontrib-googleanalytics==0.4
106+
pip install sphinxcontrib-googleanalytics==0.4 sphinxcontrib-spelling
107107
108108
- name: Install dpnp dependencies
109109
run: |

doc/conf.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,18 @@
5959
"sphinx.ext.autodoc",
6060
"sphinx.ext.autosummary",
6161
"sphinxcontrib.googleanalytics",
62+
"sphinxcontrib.spelling",
6263
]
6364

6465
googleanalytics_id = "G-554F8VNE28"
6566
googleanalytics_enabled = True
6667

68+
# Enable a misspelling as a sphinx warning
69+
spelling_warning = True
70+
71+
# Define a list of words known to be spelled correctly
72+
spelling_word_list_filename = "known_words.txt"
73+
6774
# Add any paths that contain templates here, relative to this directory.
6875
templates_path = ["_templates"]
6976

doc/known_words.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
conda
2+
dpctl
3+
oneAPI

0 commit comments

Comments
 (0)