Skip to content

Commit 04bb23b

Browse files
datapythonistaPingviinituutti
authored andcommitted
DOC: Removing remaining spellcheck related stuff (deps, docs, code, whatsnew) (pandas-dev#24299)
1 parent 5ac8166 commit 04bb23b

File tree

5 files changed

+4
-37
lines changed

5 files changed

+4
-37
lines changed

doc/make.py

+3-15
Original file line numberDiff line numberDiff line change
@@ -232,9 +232,9 @@ def _sphinx_build(self, kind):
232232
--------
233233
>>> DocBuilder(num_jobs=4)._sphinx_build('html')
234234
"""
235-
if kind not in ('html', 'latex', 'spelling'):
236-
raise ValueError('kind must be html, latex or '
237-
'spelling, not {}'.format(kind))
235+
if kind not in ('html', 'latex'):
236+
raise ValueError('kind must be html or latex, '
237+
'not {}'.format(kind))
238238

239239
self._run_os('sphinx-build',
240240
'-j{}'.format(self.num_jobs),
@@ -313,18 +313,6 @@ def zip_html(self):
313313
'-q',
314314
*fnames)
315315

316-
def spellcheck(self):
317-
"""Spell check the documentation."""
318-
self._sphinx_build('spelling')
319-
output_location = os.path.join('build', 'spelling', 'output.txt')
320-
with open(output_location) as output:
321-
lines = output.readlines()
322-
if lines:
323-
raise SyntaxError(
324-
'Found misspelled words.'
325-
' Check pandas/doc/build/spelling/output.txt'
326-
' for more details.')
327-
328316

329317
def main():
330318
cmds = [method for method in dir(DocBuilder) if not method.startswith('_')]

doc/source/contributing.rst

-19
Original file line numberDiff line numberDiff line change
@@ -458,25 +458,6 @@ the documentation are also built by Travis-CI. These docs are then hosted `here
458458
<http://pandas-docs.github.io/pandas-docs-travis>`__, see also
459459
the :ref:`Continuous Integration <contributing.ci>` section.
460460

461-
Spell checking documentation
462-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
463-
464-
When contributing to documentation to **pandas** it's good to check if your work
465-
contains any spelling errors. Sphinx provides an easy way to spell check documentation
466-
and docstrings.
467-
468-
Running the spell check is easy. Just navigate to your local ``pandas/doc/`` directory and run::
469-
470-
python make.py spellcheck
471-
472-
The spellcheck will take a few minutes to run (between 1 to 6 minutes). Sphinx will alert you
473-
with warnings and misspelt words - these misspelt words will be added to a file called
474-
``output.txt`` and you can find it on your local directory ``pandas/doc/build/spelling/``.
475-
476-
The Sphinx spelling extension uses an EN-US dictionary to correct words, what means that in
477-
some cases you might need to add a word to this dictionary. You can do so by adding the word to
478-
the bag-of-words file named ``spelling_wordlist.txt`` located in the folder ``pandas/doc/``.
479-
480461
.. _contributing.code:
481462

482463
Contributing to the code base

doc/source/whatsnew/v0.24.0.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1296,7 +1296,7 @@ Performance Improvements
12961296
Documentation Changes
12971297
~~~~~~~~~~~~~~~~~~~~~
12981298

1299-
- Added sphinx spelling extension, updated documentation on how to use the spell check (:issue:`21079`)
1299+
-
13001300
-
13011301
-
13021302

environment.yml

-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ dependencies:
2121
- moto
2222
- pytest>=4.0
2323
- sphinx
24-
- sphinxcontrib-spelling
2524
- numpydoc
2625

2726
# optional

requirements-dev.txt

-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ isort
1212
moto
1313
pytest>=4.0
1414
sphinx
15-
sphinxcontrib-spelling
1615
numpydoc
1716
beautifulsoup4>=4.2.1
1817
blosc

0 commit comments

Comments
 (0)