From 26a15af48495370d62be31f02fad16d4a05f9265 Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Sun, 16 Dec 2018 00:42:24 +0000 Subject: [PATCH 1/2] DOC: Removing remaining spellcheck related stuff (deps, docs, code, whatsnew) --- doc/make.py | 18 +++--------------- doc/source/contributing.rst | 19 ------------------- doc/source/whatsnew/v0.24.0.rst | 2 +- environment.yml | 1 - 4 files changed, 4 insertions(+), 36 deletions(-) diff --git a/doc/make.py b/doc/make.py index 0a3a7483fcc91..bb6a90c371f81 100755 --- a/doc/make.py +++ b/doc/make.py @@ -229,9 +229,9 @@ def _sphinx_build(self, kind): -------- >>> DocBuilder(num_jobs=4)._sphinx_build('html') """ - if kind not in ('html', 'latex', 'spelling'): - raise ValueError('kind must be html, latex or ' - 'spelling, not {}'.format(kind)) + if kind not in ('html', 'latex'): + raise ValueError('kind must be html or latex, ' + 'not {}'.format(kind)) self._run_os('sphinx-build', '-j{}'.format(self.num_jobs), @@ -310,18 +310,6 @@ def zip_html(self): '-q', *fnames) - def spellcheck(self): - """Spell check the documentation.""" - self._sphinx_build('spelling') - output_location = os.path.join('build', 'spelling', 'output.txt') - with open(output_location) as output: - lines = output.readlines() - if lines: - raise SyntaxError( - 'Found misspelled words.' - ' Check pandas/doc/build/spelling/output.txt' - ' for more details.') - def main(): cmds = [method for method in dir(DocBuilder) if not method.startswith('_')] diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 2ce3649666346..b88f0d3c33fc7 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -458,25 +458,6 @@ the documentation are also built by Travis-CI. These docs are then hosted `here `__, see also the :ref:`Continuous Integration ` section. -Spell checking documentation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -When contributing to documentation to **pandas** it's good to check if your work -contains any spelling errors. Sphinx provides an easy way to spell check documentation -and docstrings. - -Running the spell check is easy. Just navigate to your local ``pandas/doc/`` directory and run:: - - python make.py spellcheck - -The spellcheck will take a few minutes to run (between 1 to 6 minutes). Sphinx will alert you -with warnings and misspelt words - these misspelt words will be added to a file called -``output.txt`` and you can find it on your local directory ``pandas/doc/build/spelling/``. - -The Sphinx spelling extension uses an EN-US dictionary to correct words, what means that in -some cases you might need to add a word to this dictionary. You can do so by adding the word to -the bag-of-words file named ``spelling_wordlist.txt`` located in the folder ``pandas/doc/``. - .. _contributing.code: Contributing to the code base diff --git a/doc/source/whatsnew/v0.24.0.rst b/doc/source/whatsnew/v0.24.0.rst index 8967e8f16b69f..db1758199be0d 100644 --- a/doc/source/whatsnew/v0.24.0.rst +++ b/doc/source/whatsnew/v0.24.0.rst @@ -1296,7 +1296,7 @@ Performance Improvements Documentation Changes ~~~~~~~~~~~~~~~~~~~~~ -- Added sphinx spelling extension, updated documentation on how to use the spell check (:issue:`21079`) +- - - diff --git a/environment.yml b/environment.yml index a7eb6608b6045..42da3e31de548 100644 --- a/environment.yml +++ b/environment.yml @@ -21,7 +21,6 @@ dependencies: - moto - pytest>=4.0 - sphinx - - sphinxcontrib-spelling - numpydoc # optional From 4d03f6a8dffdf71ad9d6e482240b9f396e15f529 Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Sun, 16 Dec 2018 01:38:00 +0000 Subject: [PATCH 2/2] Synchronizing pip dependencies with conda --- requirements-dev.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/requirements-dev.txt b/requirements-dev.txt index fe319f8be1386..a7aa0bacb5bd6 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -12,7 +12,6 @@ isort moto pytest>=4.0 sphinx -sphinxcontrib-spelling numpydoc beautifulsoup4>=4.2.1 blosc