mixxorz / behave-django

Behave BDD integration for Django
https://pythonhosted.org/behave-django/
38 stars 5 forks source link

Move documentation from Wiki to a docs folder in the project repo #16

Closed bittner closed 9 years ago

bittner commented 9 years ago

As of today, the documentation is in the repository's Wiki. It should be moved to a docs folder in the project repository and converted to reStructuredText. This way pull requests can include changes to the documentation that reflect the changes made to the source code.

Things to do afterwards:

nikolas commented 9 years ago

I agree! It would be great to get this documentation into the docs/ dir and up on readthedocs.org. Then I could submit pull requests for the documentation. For example, I'd like to add a note about how to integrate splinter with behave-django. The current getting started page on the wiki mentions this but doesn't go into depth.

mixxorz commented 9 years ago

When I started this project, I thought I'd be easier to just use the Wiki. But I guess using Sphinx or readthedocs would be better. I've never tried it before though. :stuck_out_tongue:

mixxorz commented 9 years ago

This is implemented by #20. Docs are now at pythonhosted.org