Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

for python 2.7 #58

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

for python 2.7 #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/source/Introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ Setup

First install the following dependencies (`pip install` is your friend):

* ``django``
* ``django``
Python 2.7 only supports django 1.11 please use:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not rendering well:
https://github.com/omps/avocado-server/blob/f4da01b618684b9525cffff76a52447583836b89/docs/source/Introduction.rst

Could you please improve the situation a bit?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which part?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence "Python 2.7..." is being considered continuation line of the previous bullet item. Maybe the best solution would be:

* ``django`` (with Python 2.7, use ``django==1.11``)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually the whole paragraph is doomed to be outdated as the requirements.txt is the file that should be used to get dependencies. Currently there are hardcoded dependencies as it's being used by Travis, but we could create requirements-travis.txt and use >= and <= to specify the ranges.

@omps do you feel like doing this or should we change it ourselves? (basically it's about changing the docs to use pip install -r requirements.txt, cp requirements.txt requirements-travis.txt, changing .travis.yml to use requirements-travis.txt and then modifying requirements.txt to use ranges with python2 dependency (see https://github.com/avocado-framework/avocado/blob/master/requirements.txt for conditional deps)

* ``django==1.11``
* ``djangorestframework``
* ``drf-nested-routers``

Expand Down