Skip to content

README.md

Latest commit

 

History

History
34 lines (22 loc) · 1.45 KB

README.md

File metadata and controls

34 lines (22 loc) · 1.45 KB

Motivation

A range of scripts used for building documentation, interaction with docker and so on is identical for majority of implemented projects. This repository is intended to be a holder for such scripts. It can be easily referenced as a git sub module:

$ git submodule add https://github.com/lukaszlaszko/scripts.git scripts

Scripts

Following scripts have been defined in this repository:

  • docs - automating doc comments to human readable documentation conversion.

    • build_docs.sh

      Runs doxygen with configuration from docs/doxygen.cfg and saves reasults to a given directory:

      $ docs/build_docs.sh -t bin_docs

      The script automatically detects repository root directory, name, current branch and latest tags in order to place generated documentation in a proper output directory and supplement it with version information.

    • push_docs.sh

      Pushes documentation generated with build_docs.sh into a git repository.

      $ docs/push_docs.sh -c -r git@github.com:lukaszlaszko/lukaszlaszko.git -d bin_docs/*

      Initially developed to support publication of autogenerated documentation from Travis CI into github pages.