Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 4 additions & 0 deletions docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 27439670ca8433d983338dcacbc7d89a
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/.doctrees/history.doctree
Binary file not shown.
Binary file added docs/.doctrees/index.doctree
Binary file not shown.
Binary file added docs/.doctrees/installation.doctree
Binary file not shown.
Binary file added docs/.doctrees/readme.doctree
Binary file not shown.
Binary file added docs/.doctrees/usage.doctree
Binary file not shown.
1 change: 1 addition & 0 deletions docs/_sources/history.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../HISTORY.rst
25 changes: 25 additions & 0 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Welcome to Cucumber's documentation!
======================================

..
.. include:: installation.rst
.. include:: usage.rst


.. toctree::
:maxdepth: 2
:caption: Contents:

readme
installation
usage
modules
contributing
history


Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
50 changes: 50 additions & 0 deletions docs/_sources/installation.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
.. highlight:: shell

============
Installation
============


Stable release
--------------

To install Cucumber, run this command in your terminal:

.. code-block:: console

$ pip install cucumber

or for the newest:

.. code-block:: console

$ pip install git://github.com/knutdrand/cucumber


If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


From sources
------------

The sources for Cucumber can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

$ git clone git://github.com/knutdrand/cucumber

Once you have a copy of the source, you can install it with:

.. code-block:: console

$ pip install -e .


.. _Github repo: https://github.com/knutdrand/cucumber
.. _tarball: https://github.com/knutdrand/cucumber/tarball/master
1 change: 1 addition & 0 deletions docs/_sources/readme.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../README.rst
7 changes: 7 additions & 0 deletions docs/_sources/usage.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
=====
Usage
=====

To use Cucumber in a project::

import cucumber
Loading
Loading