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

Commit b2c8033

Browse files
authored
docs(README): add livingdocs cli command
1 parent 6c81701 commit b2c8033

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Overview
22
========
33
[![Build Status](https://travis-ci.org/discogs/python-livingdocs.svg?branch=master)](https://travis-ci.org/discogs/python-livingdocs) [![Coverage Status](https://coveralls.io/repos/github/discogs/python-livingdocs/badge.svg?branch=master)](https://coveralls.io/github/discogs/python-livingdocs?branch=master) [![codecov](https://codecov.io/gh/discogs/python-livingdocs/branch/master/graph/badge.svg)](https://codecov.io/gh/discogs/python-livingdocs) [![PyPI](https://img.shields.io/pypi/v/livingdocs.svg?maxAge=2592000)](https://pypi.python.org/pypi/livingdocs) [![PyPI](https://img.shields.io/pypi/wheel/livingdocs.svg?maxAge=2592000)](https://pypi.python.org/pypi/livingdocs)
44

5-
Using a Python BDD test runner like [behave], create living documentation from your BDD feature files. This library will create documents that contain up-to-date information about your BDD specs.
5+
Using a Python BDD test runner like [behave], create living documentation from your BDD feature files. This library will create documents that contain up-to-date information about your BDD specs and helps generate a static site for your living documentation.
66

77
Current supported document types:
88

@@ -13,8 +13,18 @@ Installation
1313

1414
pip install livingdocs
1515

16+
You should also install the Hugo binaries in order to generate your static site: https://gohugo.io/overview/installing/
17+
1618
Quick Start
1719
-----------
20+
Use the CLI command `livingdocs` to configure your Hugo site:
21+
```
22+
$ livingdocs
23+
Your site's title: <enter title>
24+
Your site's description: <enter description>
25+
....
26+
```
27+
This will create a `livingdocs` folder in your root directory which will have a Hugo skeleton to create a static site.
1828

1929
Using a test runner like [behave], you can generate documents for each feature, scenario and step. In **environment.py**, you can use the DocsMaker to capture this information:
2030

@@ -45,6 +55,9 @@ Using a test runner like [behave], you can generate documents for each feature,
4555
take a snapshot of this step.
4656
"""
4757
context.docs.end_step(context, step)
58+
59+
60+
4861

4962
Development
5063
-----------

0 commit comments

Comments
 (0)