Skip to content
This repository was archived by the owner on Jan 22, 2020. It is now read-only.

Commit 3bd32a9

Browse files
authored
doc(README): update
1 parent b2c8033 commit 3bd32a9

File tree

1 file changed

+40
-20
lines changed

1 file changed

+40
-20
lines changed

README.rst

+40-20
Original file line numberDiff line numberDiff line change
@@ -41,68 +41,88 @@ Overview
4141

4242
.. end-badges
4343
44-
Using a Python BDD test runner like `behave <http://pythonhosted.org/behave/>`_, create living documentation from your BDD feature files. This library will create documents that contain up-to-date information about your BDD specs.
45-
44+
Using a Python BDD test runner like `behave`_, create living
45+
documentation from your BDD feature files. This library will create
46+
documents that contain up-to-date information about your BDD specs and
47+
helps generate a static site for your living documentation.
4648

4749
Current supported document types:
4850

49-
* `*.mmark` files (to be used by `Hugo <https://gohugo.io/>`_)
50-
51+
- \*.mmark files (to be used by `Hugo`_)
5152

5253
Installation
53-
============
54+
------------
5455

5556
::
5657

5758
pip install livingdocs
5859

60+
You should also install the Hugo binaries in order to generate your
61+
static site: https://gohugo.io/overview/installing/
62+
5963
Quick Start
60-
============
64+
-----------
65+
66+
Use the CLI command ``livingdocs`` to configure your Hugo site:
67+
68+
::
69+
70+
$ livingdocs
71+
Your site's title: <enter title>
72+
Your site's description: <enter description>
73+
....
6174

62-
Using a test runner like `behave <http://pythonhosted.org/behave/>`_, you can generate documents for each feature, scenario and step. In **environment.py**, you can use the DocsMaker to capture this information:
75+
This will create a ``livingdocs`` folder in your root directory which
76+
will have a Hugo skeleton to create a static site.
6377

78+
Using a test runner like `behave`_, you can generate documents for each
79+
feature, scenario and step. In **environment.py**, you can use the
80+
DocsMaker to capture this information:
6481

6582
::
6683

6784
from livingdocs.maker import DocsMaker
68-
85+
6986
def before_all(context):
7087
context.docs = DocsMaker('feature')
71-
88+
7289
def before_scenario(context, scenario):
7390
context.docs.start_scenario(context, scenario)
74-
91+
7592
def after_scenario(context, scenario):
7693
context.docs.end_scenario(context, scenario)
77-
94+
7895
def before_feature(context, feature):
7996
context.docs.start_feature(context, feature)
80-
97+
8198
def after_feature(context, feature):
8299
context.docs.end_feature(context, feature)
83-
100+
84101
def before_step(context, step):
85102
context.docs.start_step(context, step)
86-
103+
87104
def after_step(context, step):
88105
"""
89106
if context.browser is an instance
90107
of Selenium Webdriver, then it will
91108
take a snapshot of this step.
92109
"""
93110
context.docs.end_step(context, step)
94-
111+
95112

96113
Development
97-
===========
114+
-----------
98115

99-
First create a virtual env, then to run the tests use::
116+
First create a virtual env, then to run the tests use:
100117

101-
tox -e py27
118+
::
102119

120+
tox -e py27
103121

104122
License
105-
========
123+
-------
106124

107-
* BSD license
125+
- BSD License
108126

127+
.. _behave: http://pythonhosted.org/behave/
128+
.. _Hugo: https://gohugo.io/

0 commit comments

Comments
 (0)