diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-10 16:51:20 -0800 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-10 16:51:20 -0800 |
| commit | f523badfb0bf41ea7b42798673788c93dfd0273e (patch) | |
| tree | d1c7b788140a92a0bc7e34001c1826dd9380da2e | |
| parent | 7ce31c1553ac5126e1be92d9e3431c717e5c091a (diff) | |
| parent | 59075dfd1bc18ad778d04425d8941e07352d7bba (diff) | |
| download | cryptography-f523badfb0bf41ea7b42798673788c93dfd0273e.tar.gz cryptography-f523badfb0bf41ea7b42798673788c93dfd0273e.tar.bz2 cryptography-f523badfb0bf41ea7b42798673788c93dfd0273e.zip | |
Merge pull request #454 from alex/sphinx-spellcheck
Try to run the spellchecker on travis
| -rwxr-xr-x | .travis/install.sh | 5 | ||||
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/security.rst | 2 | ||||
| -rw-r--r-- | docs/spelling_wordlist.txt | 28 | ||||
| -rw-r--r-- | tox.ini | 3 |
5 files changed, 38 insertions, 1 deletions
diff --git a/.travis/install.sh b/.travis/install.sh index 8d6840f2..e6ea2537 100755 --- a/.travis/install.sh +++ b/.travis/install.sh @@ -9,6 +9,11 @@ if [[ "${OPENSSL}" == "0.9.8" && "$(uname -s)" != "Darwin" ]]; then sudo apt-get install -y --force-yes libssl-dev/lucid fi +if [[ "${TOX_ENV}" == "docs" && "$(name -s)" != "Darwin" ]]; then + sudo apt-get -y update + sudo apt-get install libenchant-dev +fi + if [[ "$(uname -s)" == "Darwin" ]]; then brew update brew install pyenv diff --git a/docs/conf.py b/docs/conf.py index 00660314..a42dcb22 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,6 +38,7 @@ extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', 'cryptography-docs', + 'sphinxcontrib.spelling', ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/security.rst b/docs/security.rst index 2b96d589..4dadc847 100644 --- a/docs/security.rst +++ b/docs/security.rst @@ -9,4 +9,4 @@ key is available from most commonly-used key servers). Once you've submitted an issue via email, you should receive an acknowledgment within 48 hours, and depending on the action to be taken, you may receive -further followup emails. +further follow-up emails. diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt new file mode 100644 index 00000000..97356c24 --- /dev/null +++ b/docs/spelling_wordlist.txt @@ -0,0 +1,28 @@ +backend +backends +boolean +ciphertext +committer +crypto +cryptographic +cryptographically +decrypt +decrypted +decrypting +fernet +hazmat +indistinguishability +introspectability +invariants +pickleable +plaintext +testability +unencrypted +unpadded +unpadding +Backends +Blowfish +Changelog +Docstrings +Fernet +Schneier @@ -13,7 +13,9 @@ commands = [testenv:docs] deps = + pyenchant sphinx + sphinxcontrib-spelling sphinx_rtd_theme basepython = python2.7 commands = @@ -21,6 +23,7 @@ commands = sphinx-build -W -b latex -d {envtmpdir}/doctrees docs docs/_build/latex sphinx-build -W -b doctest -d {envtmpdir}/doctrees docs docs/_build/html sphinx-build -W -b linkcheck docs docs/_build/html + sphinx-build -W -b spelling docs docs/_build/html # Temporarily disable coverage on pypy because of performance problems with # coverage.py on pypy. |