diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2014-03-18 10:23:13 -0700 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2014-03-18 10:23:13 -0700 |
| commit | 9d64c02c142ed69750f8d04f3dd5849c593e8928 (patch) | |
| tree | e0c2671f4af2d5acacb28c99506ae31d43d98078 /docs/development/getting-started.rst | |
| parent | 38c42635490d24d7ee88041b52002156c6f5a676 (diff) | |
| parent | c5fffd3b33ace832697e2086411dc4e4f1ab03d0 (diff) | |
| download | cryptography-9d64c02c142ed69750f8d04f3dd5849c593e8928.tar.gz cryptography-9d64c02c142ed69750f8d04f3dd5849c593e8928.tar.bz2 cryptography-9d64c02c142ed69750f8d04f3dd5849c593e8928.zip | |
Merge pull request #827 from public/title-case
Standardise on sentence case for titles
Diffstat (limited to 'docs/development/getting-started.rst')
| -rw-r--r-- | docs/development/getting-started.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/development/getting-started.rst b/docs/development/getting-started.rst index 412f0545..3d9012eb 100644 --- a/docs/development/getting-started.rst +++ b/docs/development/getting-started.rst @@ -1,4 +1,4 @@ -Getting Started +Getting started =============== Working on ``cryptography`` requires the installation of a small number of @@ -14,7 +14,7 @@ dependencies, install ``cryptography`` in ``editable`` mode. For example: You are now ready to run the tests and build the documentation. -Running Tests +Running tests ~~~~~~~~~~~~~ ``cryptography`` unit tests are found in the ``tests/`` directory and are @@ -49,7 +49,7 @@ You may not have all the required Python versions installed, in which case you will see one or more ``InterpreterNotFound`` errors. -Explicit Backend Selection +Explicit backend selection ~~~~~~~~~~~~~~~~~~~~~~~~~~ While testing you may want to run tests against a subset of the backends that @@ -63,7 +63,7 @@ delimited list of backend names. $ tox -- --backend=openssl $ py.test --backend=openssl,commoncrypto -Building Documentation +Building documentation ~~~~~~~~~~~~~~~~~~~~~~ ``cryptography`` documentation is stored in the ``docs/`` directory. It is |