Skip to content

Commit 34560a5

Browse files
authored
Spelling remove (#5130)
* remove spelling config and docs, this didnt pan out. * added line break
1 parent e1fae5e commit 34560a5

File tree

5 files changed

+2
-396
lines changed

5 files changed

+2
-396
lines changed

docs/Makefile

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ html-quick:
2020
echo "make html-quick in $$i..."; \
2121
(cd $$i; $(MAKE) $(MFLAGS) $(MYMAKEFLAGS) html-quick); done
2222

23-
spelling:
24-
@for i in $(SUBDIRS); do \
25-
echo "make spelling in $$i..."; \
26-
(cd $$i; $(MAKE) $(MFLAGS) $(MYMAKEFLAGS) spelling); done
27-
2823
all:
2924
@for i in $(SUBDIRS); do \
3025
echo "make all in $$i..."; \

docs/src/Makefile

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,6 @@ html-quick:
6262
@echo
6363
@echo "Build finished. The HTML (no gallery or api docs) pages are in $(BUILDDIR)/html"
6464

65-
spelling:
66-
$(SPHINXBUILD) -b spelling $(SRCDIR) $(BUILDDIR)
67-
@echo
68-
@echo "Build finished. The HTML (no gallery) pages are in $(BUILDDIR)/html"
69-
7065
dirhtml:
7166
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
7267
@echo
@@ -156,4 +151,5 @@ doctest:
156151
"results in $(BUILDDIR)/doctest/output.txt."
157152

158153
show:
159-
@python -c "import webbrowser; webbrowser.open_new_tab('file://$(shell pwd)/$(BUILDDIR)/html/index.html')"
154+
@python -c "import webbrowser; webbrowser.open_new_tab('file://$(shell pwd)/$(BUILDDIR)/html/index.html')"
155+

docs/src/conf.py

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,6 @@ def _dotv(version):
158158
"sphinx_copybutton",
159159
"sphinx.ext.napoleon",
160160
"sphinx_panels",
161-
# TODO: Spelling extension disabled until the dependencies can be included
162-
# "sphinxcontrib.spelling",
163161
"sphinx_gallery.gen_gallery",
164162
"matplotlib.sphinxext.mathmpl",
165163
"matplotlib.sphinxext.plot_directive",
@@ -193,16 +191,6 @@ def _dotv(version):
193191
napoleon_use_keyword = True
194192
napoleon_custom_sections = None
195193

196-
# -- spellingextension --------------------------------------------------------
197-
# See https://sphinxcontrib-spelling.readthedocs.io/en/latest/customize.html
198-
spelling_lang = "en_GB"
199-
# The lines in this file must only use line feeds (no carriage returns).
200-
spelling_word_list_filename = ["spelling_allow.txt"]
201-
spelling_show_suggestions = False
202-
spelling_show_whole_line = False
203-
spelling_ignore_importable_modules = True
204-
spelling_ignore_python_builtins = True
205-
206194
# -- copybutton extension -----------------------------------------------------
207195
# See https://sphinx-copybutton.readthedocs.io/en/latest/
208196
copybutton_prompt_text = r">>> |\.\.\. "

docs/src/developers_guide/contributing_documentation_full.rst

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -113,18 +113,6 @@ adding it to the ``linkcheck_ignore`` array that is defined in the
113113
If this fails check the output for the text **broken** and then correct
114114
or ignore the url.
115115

116-
.. comment
117-
Finally, the spelling in the documentation can be checked automatically via the
118-
command::
119-
120-
make spelling
121-
122-
The spelling check may pull up many technical abbreviations and acronyms. This
123-
can be managed by using an **allow** list in the form of a file. This file,
124-
or list of files is set in the `conf.py`_ using the string list
125-
``spelling_word_list_filename``.
126-
127-
128116
.. note:: In addition to the automated `Iris GitHub Actions`_ build of all the
129117
documentation build options above, the
130118
https://readthedocs.org/ service is also used. The configuration

0 commit comments

Comments
 (0)