Metadata-Version: 2.1
Name: shelldoc
Version: 0.0.2
Summary: Google syle shell documentation generator tool
Home-page: https://github.com/antscloud/shelldoc.git
Author: Antoine Gibek
Project-URL: Bug Tracker, https://github.com/antscloud/shelldoc.git
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown

# Installation 

Just `pip install shelldoc`

# Usage 

```
usage: shelldoc [-h] -f FILES [FILES ...] [-d DEST]

Generate documentation from shell script

optional arguments:
  -h, --help            show this help message and exit
  -f FILES [FILES ...], --files FILES [FILES ...]
                        Files to generate documentation from
  -d DEST, --dest DEST  Directory to generate documentation in. ./docs by default
```
# Specifications

This documentation generation tool is based on [Google Shell Style Guide](https://google.github.io/styleguide/shellguide.html)

For example : 

```bash
#######################################
# Get configuration directory.
# Globals:
#   SOMEDIR
# Arguments:
#   None
# Outputs:
#   Writes location to stdout
# See: 
#   https://stackoverflow.com/questions/59895/getting-the-source-directory-of-a-bash-script-from-within
#   del_thing
#######################################
```

The following parameters are available :
- Globals
- Arguments
- Outputs
- Returns 
- See
- Raises

Also, the `TODO` are parsed.
