Git Product home page Git Product logo

sami-phpci-plugin's Introduction

Sami PHPCI Plugin

Sami PHPCI Plugin gives the possibility to generate a documentation with Sami in PHPCI.

Installation

This plugin can be installed via composer:

composer require mauchede/sami-phpci-plugin

Usage

This plugin takes the following options:

  • config (string, optional): Allows you to pass the Sami configuration file. The default value is ./sami.php.
  • force (boolean, optional): Allows you to force (or not) to rebuild from scratch. The default value is true.

An example of phpci.yml with this plugin:

complete:
    \Mauchede\PHPCI\Plugin\Sami:
        config: sami.config.file
        force: false

Contributing

  1. Fork it.
  2. Create your branch: git checkout -b my-new-feature.
  3. Commit your changes: git commit -am 'Add some feature'.
  4. Push to the branch: git push origin my-new-feature.
  5. Submit a pull request.

Links

sami-phpci-plugin's People

Contributors

mauchede avatar

Watchers

 avatar  avatar

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.