Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(GH-697) Automatically generate documentation #720

Merged
merged 12 commits into from
Jun 3, 2016
Merged
358 changes: 358 additions & 0 deletions .build.custom/GenerateDocs.ps1

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ If you need the previous behavior, be sure to disable the feature `usePackageExi
* Fix - Logger doesn't clear cached NullLoggers - see [#516](https://github.com/chocolatey/choco/issues/516)
* Fix - DISM "/All" argument in the wrong position - see [#480](https://github.com/chocolatey/choco/issues/480)
* Fix - Pro - Installing/uninstalling extensions should rename files in use - see [#594](https://github.com/chocolatey/choco/issues/594)
* Fix - Running Get-FileName in PowerShell 5 fails and sometimes causes package errors - see [#603](https://github.com/chocolatey/choco/issues/603)
* Fix - Running Get-WebFileName in PowerShell 5 fails and sometimes causes package errors - see [#603](https://github.com/chocolatey/choco/issues/603)
* Fix - Merging assemblies on a machine running .Net 4.5 or higher produces binaries incompatible with .Net 4 - see [#392](https://github.com/chocolatey/choco/issues/392)
* Fix - API - Incorrect log4net version in chocolatey.lib dependencies - see [#390](https://github.com/chocolatey/choco/issues/390)
* [POSH Host] Fix - Message after Download progress is on the same line sometimes - see [#525](https://github.com/chocolatey/choco/issues/525)
Expand Down
101 changes: 101 additions & 0 deletions docs/generated/CommandsApiKey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# ApiKey Command (choco apiKey)

This lists api keys that are set or sets an api key for a particular
source so it doesn't need to be specified every time.

Anything that doesn't contain source and key will list api keys.

## Usage

choco apikey [<options/switches>]
choco setapikey [<options/switches>]

## Examples

choco apikey
choco apikey -s"https://somewhere/out/there"
choco apikey -s"https://somewhere/out/there/" -k="value"
choco apikey -s"https://chocolatey.org/" -k="123-123123-123"

## Connecting to Chocolatey.org

In order to save your API key for https://chocolatey.org/,
log in (or register, confirm and then log in) to
https://chocolatey.org/, go to https://chocolatey.org/account,
copy the API Key, and then use it in the following command:

choco apikey -k <your key here> -s https://chocolatey.org/


## Options and Switches

**NOTE:** Options and switches apply to all items passed, so if you are
running a command like install that allows installing multiple
packages, and you use `--version=1.0.0`, it is going to look for and
try to install version 1.0.0 of every package passed. So please split
out multiple package calls when wanting to pass specific options.

Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).

~~~

-?, --help, -h
Prints out the help menu.

-d, --debug
Debug - Run in Debug Mode.

-v, --verbose
Verbose - See verbose messaging.

--acceptlicense, --accept-license
AcceptLicense - Accept license dialogs automatically.

-y, --yes, --confirm
Confirm all prompts - Chooses affirmative answer instead of prompting.
Implies --accept-license

-f, --force
Force - force the behavior

--noop, --whatif, --what-if
NoOp - Don't actually do anything.

-r, --limitoutput, --limit-output
LimitOutput - Limit the output to essential information

--timeout, --execution-timeout=VALUE
CommandExecutionTimeout (in seconds) - The time to allow a command to
finish before timing out. Overrides the default execution timeout in the
configuration of 2700 seconds.

-c, --cache, --cachelocation, --cache-location=VALUE
CacheLocation - Location for download cache, defaults to %TEMP% or value
in chocolatey.config file.

--allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
AllowUnofficialBuild - When not using the official build you must set
this flag for choco to continue.

--failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
FailOnStandardError - Fail on standard error output (stderr), typically
received when running external commands during install providers. This
overrides the feature failOnStandardError.

--use-system-powershell
UseSystemPowerShell - Execute PowerShell using an external process
instead of the built-in PowerShell host. Available in 0.9.10+.

-s, --source=VALUE
Source [REQUIRED] - The source location for the key

-k, --key, --apikey, --api-key=VALUE
ApiKey - The api key for the source.

~~~

[[Command Reference|CommandsReference]]


***NOTE:*** This documentation has been automatically generated from `choco apiKey -h`.

103 changes: 103 additions & 0 deletions docs/generated/CommandsConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Config Command (choco config)

Chocolatey will allow you to interact with the configuration file settings.

**NOTE:** Available in 0.9.9.9+.

## Usage

choco config [list]|get|set|unset [<options/switches>]

**NOTE:** `Unset` subcommand available in 0.9.10+.

## Examples

choco config
choco config list
choco config get cacheLocation
choco config get --name cacheLocation
choco config set cacheLocation c:\temp\choco
choco config set --name cacheLocation --value c:\temp\choco
choco config unset proxy
choco config unset --name proxy


## See It In Action

![Config shown in action](https://raw.githubusercontent.com/wiki/chocolatey/choco/images/gifs/choco_config.gif)


## Options and Switches

**NOTE:** Options and switches apply to all items passed, so if you are
running a command like install that allows installing multiple
packages, and you use `--version=1.0.0`, it is going to look for and
try to install version 1.0.0 of every package passed. So please split
out multiple package calls when wanting to pass specific options.

Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).

~~~

-?, --help, -h
Prints out the help menu.

-d, --debug
Debug - Run in Debug Mode.

-v, --verbose
Verbose - See verbose messaging.

--acceptlicense, --accept-license
AcceptLicense - Accept license dialogs automatically.

-y, --yes, --confirm
Confirm all prompts - Chooses affirmative answer instead of prompting.
Implies --accept-license

-f, --force
Force - force the behavior

--noop, --whatif, --what-if
NoOp - Don't actually do anything.

-r, --limitoutput, --limit-output
LimitOutput - Limit the output to essential information

--timeout, --execution-timeout=VALUE
CommandExecutionTimeout (in seconds) - The time to allow a command to
finish before timing out. Overrides the default execution timeout in the
configuration of 2700 seconds.

-c, --cache, --cachelocation, --cache-location=VALUE
CacheLocation - Location for download cache, defaults to %TEMP% or value
in chocolatey.config file.

--allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
AllowUnofficialBuild - When not using the official build you must set
this flag for choco to continue.

--failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
FailOnStandardError - Fail on standard error output (stderr), typically
received when running external commands during install providers. This
overrides the feature failOnStandardError.

--use-system-powershell
UseSystemPowerShell - Execute PowerShell using an external process
instead of the built-in PowerShell host. Available in 0.9.10+.

--name=VALUE
Name - the name of the config setting. Required with some actions.
Defaults to empty.

--value=VALUE
Value - the value of the config setting. Required with some actions.
Defaults to empty.

~~~

[[Command Reference|CommandsReference]]


***NOTE:*** This documentation has been automatically generated from `choco config -h`.

85 changes: 85 additions & 0 deletions docs/generated/CommandsFeature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Feature Command (choco feature)

Chocolatey will allow you to interact with features.

## Usage

choco feature [list]|disable|enable [<options/switches>]

## Examples

choco feature
choco feature list
choco feature disable -n=bob
choco feature enable -n=bob

## Options and Switches

**NOTE:** Options and switches apply to all items passed, so if you are
running a command like install that allows installing multiple
packages, and you use `--version=1.0.0`, it is going to look for and
try to install version 1.0.0 of every package passed. So please split
out multiple package calls when wanting to pass specific options.

Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).

~~~

-?, --help, -h
Prints out the help menu.

-d, --debug
Debug - Run in Debug Mode.

-v, --verbose
Verbose - See verbose messaging.

--acceptlicense, --accept-license
AcceptLicense - Accept license dialogs automatically.

-y, --yes, --confirm
Confirm all prompts - Chooses affirmative answer instead of prompting.
Implies --accept-license

-f, --force
Force - force the behavior

--noop, --whatif, --what-if
NoOp - Don't actually do anything.

-r, --limitoutput, --limit-output
LimitOutput - Limit the output to essential information

--timeout, --execution-timeout=VALUE
CommandExecutionTimeout (in seconds) - The time to allow a command to
finish before timing out. Overrides the default execution timeout in the
configuration of 2700 seconds.

-c, --cache, --cachelocation, --cache-location=VALUE
CacheLocation - Location for download cache, defaults to %TEMP% or value
in chocolatey.config file.

--allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
AllowUnofficialBuild - When not using the official build you must set
this flag for choco to continue.

--failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
FailOnStandardError - Fail on standard error output (stderr), typically
received when running external commands during install providers. This
overrides the feature failOnStandardError.

--use-system-powershell
UseSystemPowerShell - Execute PowerShell using an external process
instead of the built-in PowerShell host. Available in 0.9.10+.

-n, --name=VALUE
Name - the name of the source. Required with some actions. Defaults to
empty.

~~~

[[Command Reference|CommandsReference]]


***NOTE:*** This documentation has been automatically generated from `choco feature -h`.

85 changes: 85 additions & 0 deletions docs/generated/CommandsFeatures.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Feature Command (choco features)

Chocolatey will allow you to interact with features.

## Usage

choco feature [list]|disable|enable [<options/switches>]

## Examples

choco feature
choco feature list
choco feature disable -n=bob
choco feature enable -n=bob

## Options and Switches

**NOTE:** Options and switches apply to all items passed, so if you are
running a command like install that allows installing multiple
packages, and you use `--version=1.0.0`, it is going to look for and
try to install version 1.0.0 of every package passed. So please split
out multiple package calls when wanting to pass specific options.

Includes [[default options/switches|CommandsReference#default-options-and-switches]] (included below for completeness).

~~~

-?, --help, -h
Prints out the help menu.

-d, --debug
Debug - Run in Debug Mode.

-v, --verbose
Verbose - See verbose messaging.

--acceptlicense, --accept-license
AcceptLicense - Accept license dialogs automatically.

-y, --yes, --confirm
Confirm all prompts - Chooses affirmative answer instead of prompting.
Implies --accept-license

-f, --force
Force - force the behavior

--noop, --whatif, --what-if
NoOp - Don't actually do anything.

-r, --limitoutput, --limit-output
LimitOutput - Limit the output to essential information

--timeout, --execution-timeout=VALUE
CommandExecutionTimeout (in seconds) - The time to allow a command to
finish before timing out. Overrides the default execution timeout in the
configuration of 2700 seconds.

-c, --cache, --cachelocation, --cache-location=VALUE
CacheLocation - Location for download cache, defaults to %TEMP% or value
in chocolatey.config file.

--allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
AllowUnofficialBuild - When not using the official build you must set
this flag for choco to continue.

--failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
FailOnStandardError - Fail on standard error output (stderr), typically
received when running external commands during install providers. This
overrides the feature failOnStandardError.

--use-system-powershell
UseSystemPowerShell - Execute PowerShell using an external process
instead of the built-in PowerShell host. Available in 0.9.10+.

-n, --name=VALUE
Name - the name of the source. Required with some actions. Defaults to
empty.

~~~

[[Command Reference|CommandsReference]]


***NOTE:*** This documentation has been automatically generated from `choco features -h`.

Loading