mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-08 02:24:08 +00:00
Add checks for spelling
This commit is contained in:
@@ -47,6 +47,7 @@ help:
|
|||||||
@echo " linkcheck to check all external links for integrity"
|
@echo " linkcheck to check all external links for integrity"
|
||||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||||
@echo " coverage to run coverage check of the documentation (if enabled)"
|
@echo " coverage to run coverage check of the documentation (if enabled)"
|
||||||
|
@echo " spelling to run spell check on documentation"
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -rf $(BUILDDIR)/*
|
rm -rf $(BUILDDIR)/*
|
||||||
@@ -179,6 +180,11 @@ linkcheck:
|
|||||||
@echo "Link check complete; look for any errors in the above output " \
|
@echo "Link check complete; look for any errors in the above output " \
|
||||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||||
|
|
||||||
|
spelling:
|
||||||
|
$(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
|
||||||
|
@echo
|
||||||
|
@echo "Spell check complete; look for any errors in the above output " \
|
||||||
|
"or in $(BUILDDIR)/spelling/output.txt."
|
||||||
doctest:
|
doctest:
|
||||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||||
@echo "Testing of doctests in the sources finished, look at the " \
|
@echo "Testing of doctests in the sources finished, look at the " \
|
||||||
|
@@ -10,7 +10,9 @@ dependencies:
|
|||||||
- sqlalchemy>=1
|
- sqlalchemy>=1
|
||||||
- tornado>=4.1
|
- tornado>=4.1
|
||||||
- traitlets>=4.1
|
- traitlets>=4.1
|
||||||
- sphinx
|
|
||||||
- sphinx_rtd_theme
|
|
||||||
- pip:
|
- pip:
|
||||||
- recommonmark
|
- sphinx>=1.3.6
|
||||||
|
- recommonmark==0.4.0
|
||||||
|
- sphinx_rtd_theme
|
||||||
|
- pyenchant
|
||||||
|
- sphinxcontrib-spelling
|
||||||
|
@@ -38,6 +38,14 @@ extensions = [
|
|||||||
'sphinx.ext.napoleon',
|
'sphinx.ext.napoleon',
|
||||||
]
|
]
|
||||||
|
|
||||||
|
# Spelling
|
||||||
|
try:
|
||||||
|
import sphinxcontrib.spelling
|
||||||
|
except ImportError:
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
extensions.append("sphinxcontrib.spelling")
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['_templates']
|
templates_path = ['_templates']
|
||||||
|
|
||||||
@@ -391,3 +399,6 @@ else:
|
|||||||
from subprocess import check_call as sh
|
from subprocess import check_call as sh
|
||||||
sh(['make', 'rest-api'], cwd=docs)
|
sh(['make', 'rest-api'], cwd=docs)
|
||||||
# otherwise, readthedocs.org uses their theme by default, so no need to specify it
|
# otherwise, readthedocs.org uses their theme by default, so no need to specify it
|
||||||
|
|
||||||
|
# Spell checking using sphinxcontrib-spelling
|
||||||
|
spelling_word_list_filename='spelling_wordlist.txt'
|
||||||
|
213
docs/source/spelling_wordlist.txt
Normal file
213
docs/source/spelling_wordlist.txt
Normal file
@@ -0,0 +1,213 @@
|
|||||||
|
admin
|
||||||
|
Afterwards
|
||||||
|
alchemyst
|
||||||
|
alope
|
||||||
|
api
|
||||||
|
API
|
||||||
|
apps
|
||||||
|
args
|
||||||
|
asctime
|
||||||
|
auth
|
||||||
|
authenticator
|
||||||
|
Authenticator
|
||||||
|
authenticators
|
||||||
|
Authenticators
|
||||||
|
Autograde
|
||||||
|
autograde
|
||||||
|
autogradeapp
|
||||||
|
autograded
|
||||||
|
Autograded
|
||||||
|
autograder
|
||||||
|
Autograder
|
||||||
|
autograding
|
||||||
|
backends
|
||||||
|
Bitdiddle
|
||||||
|
bugfix
|
||||||
|
Bugfixes
|
||||||
|
bugtracker
|
||||||
|
Carreau
|
||||||
|
Changelog
|
||||||
|
changelog
|
||||||
|
checksum
|
||||||
|
checksums
|
||||||
|
cmd
|
||||||
|
cogsci
|
||||||
|
conda
|
||||||
|
config
|
||||||
|
coroutine
|
||||||
|
coroutines
|
||||||
|
crt
|
||||||
|
customizable
|
||||||
|
datefmt
|
||||||
|
decrypted
|
||||||
|
dev
|
||||||
|
DockerSpawner
|
||||||
|
dockerspawner
|
||||||
|
dropdown
|
||||||
|
duedate
|
||||||
|
Duedate
|
||||||
|
ellachao
|
||||||
|
ellisonbg
|
||||||
|
entrypoint
|
||||||
|
env
|
||||||
|
Filenames
|
||||||
|
filesystem
|
||||||
|
formatters
|
||||||
|
formdata
|
||||||
|
formgrade
|
||||||
|
formgrader
|
||||||
|
gif
|
||||||
|
GitHub
|
||||||
|
Gradebook
|
||||||
|
gradebook
|
||||||
|
Granger
|
||||||
|
hardcoded
|
||||||
|
hOlle
|
||||||
|
Homebrew
|
||||||
|
html
|
||||||
|
http
|
||||||
|
https
|
||||||
|
hubapi
|
||||||
|
Indices
|
||||||
|
IFramed
|
||||||
|
inline
|
||||||
|
iopub
|
||||||
|
ip
|
||||||
|
ipynb
|
||||||
|
IPython
|
||||||
|
ischurov
|
||||||
|
ivanslapnicar
|
||||||
|
jdfreder
|
||||||
|
jhamrick
|
||||||
|
jklymak
|
||||||
|
jonathanmorgan
|
||||||
|
joschu
|
||||||
|
JUPYTER
|
||||||
|
Jupyter
|
||||||
|
jupyter
|
||||||
|
jupyterhub
|
||||||
|
Kerberos
|
||||||
|
kerberos
|
||||||
|
letsencrypt
|
||||||
|
lgpage
|
||||||
|
linkcheck
|
||||||
|
linux
|
||||||
|
localhost
|
||||||
|
logfile
|
||||||
|
login
|
||||||
|
logins
|
||||||
|
logout
|
||||||
|
lookup
|
||||||
|
lphk
|
||||||
|
mandli
|
||||||
|
Marr
|
||||||
|
mathjax
|
||||||
|
matplotlib
|
||||||
|
metadata
|
||||||
|
mikebolt
|
||||||
|
minrk
|
||||||
|
Mitigations
|
||||||
|
mixin
|
||||||
|
Mixin
|
||||||
|
multi
|
||||||
|
multiuser
|
||||||
|
namespace
|
||||||
|
nbconvert
|
||||||
|
nbgrader
|
||||||
|
neuroscience
|
||||||
|
nginx
|
||||||
|
np
|
||||||
|
npm
|
||||||
|
oauth
|
||||||
|
OAuth
|
||||||
|
oauthenticator
|
||||||
|
ok
|
||||||
|
olgabot
|
||||||
|
osx
|
||||||
|
PAM
|
||||||
|
phantomjs
|
||||||
|
Phantomjs
|
||||||
|
plugin
|
||||||
|
plugins
|
||||||
|
Popen
|
||||||
|
positionally
|
||||||
|
postgres
|
||||||
|
pregenerated
|
||||||
|
prepend
|
||||||
|
prepopulate
|
||||||
|
preprocessor
|
||||||
|
Preprocessor
|
||||||
|
prev
|
||||||
|
Programmatically
|
||||||
|
programmatically
|
||||||
|
ps
|
||||||
|
py
|
||||||
|
Qualys
|
||||||
|
quickstart
|
||||||
|
readonly
|
||||||
|
redSlug
|
||||||
|
reinstall
|
||||||
|
resize
|
||||||
|
rst
|
||||||
|
runtime
|
||||||
|
rw
|
||||||
|
sandboxed
|
||||||
|
sansary
|
||||||
|
singleuser
|
||||||
|
smeylan
|
||||||
|
spawner
|
||||||
|
Spawner
|
||||||
|
spawners
|
||||||
|
Spawners
|
||||||
|
spellcheck
|
||||||
|
SQL
|
||||||
|
sqlite
|
||||||
|
startup
|
||||||
|
statsd
|
||||||
|
stdin
|
||||||
|
stdout
|
||||||
|
stoppped
|
||||||
|
subclasses
|
||||||
|
subcommand
|
||||||
|
subdomain
|
||||||
|
subdomains
|
||||||
|
Subdomains
|
||||||
|
suchow
|
||||||
|
suprocesses
|
||||||
|
svurens
|
||||||
|
sys
|
||||||
|
SystemUserSpawner
|
||||||
|
systemwide
|
||||||
|
tasilb
|
||||||
|
teardown
|
||||||
|
threadsafe
|
||||||
|
timestamp
|
||||||
|
timestamps
|
||||||
|
TLD
|
||||||
|
todo
|
||||||
|
toolbar
|
||||||
|
traitlets
|
||||||
|
travis
|
||||||
|
tuples
|
||||||
|
undeletable
|
||||||
|
unicode
|
||||||
|
uninstall
|
||||||
|
UNIX
|
||||||
|
unix
|
||||||
|
untracked
|
||||||
|
untrusted
|
||||||
|
url
|
||||||
|
username
|
||||||
|
usernames
|
||||||
|
utcnow
|
||||||
|
utils
|
||||||
|
vinaykola
|
||||||
|
virtualenv
|
||||||
|
whitelist
|
||||||
|
whitespace
|
||||||
|
wildcard
|
||||||
|
Wildcards
|
||||||
|
willingc
|
||||||
|
wordlist
|
||||||
|
Workflow
|
||||||
|
workflow
|
Reference in New Issue
Block a user