diff options
| author | Sachin <sacpatil@redhat.com> | 2016-02-21 18:02:03 +0530 |
|---|---|---|
| committer | Bryn M. Reeves <bmr@redhat.com> | 2018-03-13 12:14:20 +0000 |
| commit | 8939cda58ebf6b2ada49b5a2071747a038ebebe8 (patch) | |
| tree | 26e44f2623521e15fecc982153cf7ba2e3332130 | |
| parent | da42466ad3436fff9ea16aab2bfebab9fd586ed8 (diff) | |
| download | sos-8939cda58ebf6b2ada49b5a2071747a038ebebe8.tar.gz | |
[build] Added dependencies in requirements
* Updated instructions in README to install Python dependencies
* Added an example to create HTML docs
* Added instruction to optionally run 'make test' before sending a PR
* Relavant changes made in .travis.yml to test requirements
Signed-off-by: Sachin Patil <sacpatil@redhat.com>
| -rw-r--r-- | .travis.yml | 2 | ||||
| -rw-r--r-- | README.md | 14 | ||||
| -rw-r--r-- | requirements.txt | 4 |
3 files changed, 19 insertions, 1 deletions
diff --git a/.travis.yml b/.travis.yml index 579a63f1..ae242849 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,7 +19,7 @@ notifications: dist: trusty sudo: true install: - - "pip install six nose nose-cov pep8" + - "pip install -r requirements.txt" - "python setup.py install" script: - "pep8 sos" @@ -42,6 +42,20 @@ patches and commit messages. User and API [documentation][6] is automatically generated using [Sphinx][7] and [Read the Docs][8]. +To generate HTML documents locally, install dependencies using + +``` +pip install -r requirements.txt +``` + +and run + +``` +make +``` + +Please run `make test` before sending a [pull request][0] + ### Wiki * [How to write a plugin][1] diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..3a072cd4 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +pep8>=1.7.0 +nose>=1.3.7 +coverage>=4.0.3 +Sphinx>=1.3.5 |