Skip to content

Commit

Permalink
Updated Documentation section
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanmedd committed Mar 30, 2021
1 parent a7d5361 commit 89feaca
Showing 1 changed file with 2 additions and 19 deletions.
21 changes: 2 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,24 +113,7 @@ The default build will run some quick tests to catch any errors before you push
Documentation for each command can be viewed with Get-Help, e.g.:

```
Get-Help Get-vRAEntitlement
Get-Help Get-vRACloudAccount
```

### Updating the documentation
To update the documentation you first need to ensure that the local module manifest is updated with any new functions

```PowerShell
.\tools\build.ps1 -Task UpdateModuleManifest
```

Once complete you can run the UpdateDocumentation task to create new markdown files and update any existing ones.

```PowerShell
.\tools\build.ps1 -Task UpdateDocumentation
```

The changes can then be committed back to the repository. Once pushed, they will be reflected in ReadTheDocs.

**Documentation**

Documentation for all functions in the module can be found [here](https://jakkulabs.github.io/PowervRA/).
or online [here](https://jakkulabs.github.io/PowervRA/).

0 comments on commit 89feaca

Please sign in to comment.