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.

Sign up for GitHub

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

docs: update formatting for godocs #78

Merged
merged 6 commits into from
May 11, 2021
Merged

docs: update formatting for godocs #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e014844
add local docs
thinkingserious May 11, 2021
4e42b81
update formatting
thinkingserious May 11, 2021
f5e40e2
update formatting
thinkingserious May 11, 2021
3c2d973
update formatting
thinkingserious May 11, 2021
e61d6ef
update oai source
thinkingserious May 11, 2021
efc57ea
update
thinkingserious May 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,5 +351,22 @@ To execute the test suite run:
go test ./...
```

### Generating Local Documentation

To generate documentation, from the root directory:

```bash
godoc -http=localhost:{port number}
```

Then, navigate to `http://localhost:{port number}/pkg/github.com/twilio/twilio-go` in your local browser.

Example:

```bash
godoc -http=localhost:6060
```
http://localhost:6060/pkg/github.com/twilio/twilio-go

[apidocs]: https://www.twilio.com/docs/api
[libdocs]: https://pkg.go.dev/github.com/twilio/twilio-go?tab=versions
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ require (
github.com/pkg/errors v0.9.1
github.com/shirou/gopsutil v0.0.0-20190901111213-e4ec7b275ada // indirect
github.com/stretchr/testify v1.7.0
golang.org/x/tools v0.1.0 // indirect
golang.org/x/tools v0.1.1 // indirect
)
246 changes: 246 additions & 0 deletions go.sum
View file
Open in desktop

Large diffs are not rendered by default.

123 changes: 20 additions & 103 deletions rest/accounts/v1/api_default.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading