File tree 5 files changed +4
-37
lines changed
5 files changed +4
-37
lines changed Original file line number Diff line number Diff line change @@ -232,9 +232,9 @@ def _sphinx_build(self, kind):
232
232
--------
233
233
>>> DocBuilder(num_jobs=4)._sphinx_build('html')
234
234
"""
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 ))
238
238
239
239
self ._run_os ('sphinx-build' ,
240
240
'-j{}' .format (self .num_jobs ),
@@ -313,18 +313,6 @@ def zip_html(self):
313
313
'-q' ,
314
314
* fnames )
315
315
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
-
328
316
329
317
def main ():
330
318
cmds = [method for method in dir (DocBuilder ) if not method .startswith ('_' )]
Original file line number Diff line number Diff line change @@ -458,25 +458,6 @@ the documentation are also built by Travis-CI. These docs are then hosted `here
458
458
<http://pandas-docs.github.io/pandas-docs-travis> `__, see also
459
459
the :ref: `Continuous Integration <contributing.ci >` section.
460
460
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
-
480
461
.. _contributing.code :
481
462
482
463
Contributing to the code base
Original file line number Diff line number Diff line change @@ -1296,7 +1296,7 @@ Performance Improvements
1296
1296
Documentation Changes
1297
1297
~~~~~~~~~~~~~~~~~~~~~
1298
1298
1299
- - Added sphinx spelling extension, updated documentation on how to use the spell check ( :issue: ` 21079 `)
1299
+ -
1300
1300
-
1301
1301
-
1302
1302
Original file line number Diff line number Diff line change @@ -21,7 +21,6 @@ dependencies:
21
21
- moto
22
22
- pytest>=4.0
23
23
- sphinx
24
- - sphinxcontrib-spelling
25
24
- numpydoc
26
25
27
26
# optional
Original file line number Diff line number Diff line change 12
12
moto
13
13
pytest >= 4.0
14
14
sphinx
15
- sphinxcontrib-spelling
16
15
numpydoc
17
16
beautifulsoup4 >= 4.2.1
18
17
blosc
You can’t perform that action at this time.
0 commit comments