Giter VIP home page Giter VIP logo

Comments (2)

rnc avatar rnc commented on August 18, 2024

Also, from #5, the following environment variables should be documented:

  • MAVEN_MIRROR_URL
  • BEHAVE_TIMEOUT

from behave-test-steps.

jmtd avatar jmtd commented on August 18, 2024

--steps-catalog might help. E.g.

$ behave --dry-run --format=steps.catalog | head
Given define variable
  Location: steps/steps.py:294

Given container is started with env
  Location: steps/container_steps.py:72

Given container is started with args
  Location: steps/container_steps.py:86

Given container is started with entrypoint {entrypoint}

Possibly useful formatters (shown by --format=help are)

  • steps: groups Given/when/then which is useful, links to implementation path:line; doesn't include docs
  • steps.catalog: groups given/when/then; reports implementation path:line on an indented second line; includes docs when the steps have them;
  • steps.usage: reports on the usage of steps for a particular image. THus not generically useful

The output of steps.catalog could be lightly marked up and turned into HTML, perhaps pushd to github pages on commit.

PoC here: https://github.com/jmtd/behave-test-steps/tree/gh-pages-doc-steps ; example output: https://github.com/jmtd/behave-test-steps/blob/gh-pages-doc-steps/docs.md

from behave-test-steps.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.