Skip to content

Commit

Permalink
Remove generation of docs (grpc-ecosystem#183)
Browse files Browse the repository at this point in the history
Docs will now be only in code / in godoc.org.

We should remove the auto generation of docs from this repo, as much as it was nice to have them alongside the code in github it is normal go practice to look for most documentation via godoc.org.

The libraries that we have been using to generate the github markdown are no longer maintained and updated in the godoc codebase itself have meant that we would also have to update these dependant libraries ... which I do not think we should take.
  • Loading branch information
domgreen authored and devnev committed Jan 4, 2019
1 parent 3304cc8 commit 4832df0
Show file tree
Hide file tree
Showing 29 changed files with 4 additions and 2,512 deletions.
1 change: 0 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ install:
- dep ensure

script:
- make checkdocs
- make test

after_success:
Expand Down
166 changes: 0 additions & 166 deletions DOC.md

This file was deleted.

4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@

[gRPC Go](https://github.com/grpc/grpc-go) Middleware: interceptors, helpers, utilities.

**Important** The repo recently moved to `github.com/grpc-ecosystem/go-grpc-middleware`, please update your import paths.

## Middleware

[gRPC Go](https://github.com/grpc/grpc-go) recently acquired support for
Expand All @@ -24,7 +22,7 @@ These are generic building blocks that make it easy to build multiple microservi
The purpose of this repository is to act as a go-to point for such reusable functionality. It contains
some of them itself, but also will link to useful external repos.

`grpc_middleware` itself provides support for chaining interceptors. See [Documentation](DOC.md), but here's an example:
`grpc_middleware` itself provides support for chaining interceptors, here's an example:

```go
import "github.com/grpc-ecosystem/go-grpc-middleware"
Expand Down
148 changes: 0 additions & 148 deletions auth/DOC.md

This file was deleted.

1 change: 0 additions & 1 deletion auth/README.md

This file was deleted.

Loading

0 comments on commit 4832df0

Please sign in to comment.