devtools/cmd/evaldoc: tool for doc coverage This is the first of several CLs that implement a tool for documentation coverage. Users can run this to better understand their documentation coverage score on the evaluations page. This first CL has limited functionality: it reads only from the file system, and just writes a simple list of symbols and whether they are documented. Over the next few CLs, we'll build on that to produce a web server that shows the symbols in context. As part of this change, we modify CollectSymbols to use the Go identifier instead of a name for the symbol. That means we lose some context information, like the type that a method is defined on. This isn't going to matter for this program, because we will be showing the name in context. And it doesn't matter for production use because there we only count the number of symbols. For golang/go#80385. Change-Id: I62c84e953719c5a3f347334669b3d71b7dd10e59 Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/811060 LUCI-TryBot-Result: golang-scoped@luci-project-accounts.iam.gserviceaccount.com <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Ethan Lee <ethanalee@google.com> kokoro-CI: kokoro <noreply+kokoro@google.com>
This repository hosts the source code of the pkg.go.dev website, and pkgsite, a documentation server program.
Pkg.go.dev is a website for discovering and evaluating Go packages and modules.
You can check it out at https://pkg.go.dev.
pkgsite program extracts and generates documentation for Go projects.
Example usage:
$ go install golang.org/x/pkgsite/cmd/pkgsite@latest $ cd myproject $ pkgsite -open .
For more information, see the pkgsite documentation.
pkgsite provides a REST API for retrieving package and module information. Currently the API is on v1beta, but after a periodic of community feedback we will transition to v1. The API endpoints include:
/v1beta/package/{path}: Information about the package at {path}./v1beta/module/{path}: Information about the module at {path}./v1beta/versions/{path}: Versions of the module at {path}./v1beta/packages/{path}: Information about packages of the module at {path}./v1beta/search: Search results./v1beta/symbols/{path}: List of symbols for the package at {path}./v1beta/imported-by/{path}: Paths of packages importing the package at {path}./v1beta/vulns/{path}: Vulnerabilities of the module at {path}.For detailed documentation of parameters and response schemas, see the documentation page served at /api, or refer directly to the annotated source code in internal/api/api.go.
If you want to report a bug or have a feature suggestion, please first check the known issues to see if your issue is already being discussed. If an issue does not already exist, feel free to file an issue.
For answers to frequently asked questions, see pkg.go.dev/about.
You can also chat with us on the #pkgsite Slack channel on the Gophers Slack.
We would love your help!
Our canonical Git repository is located at go.googlesource.com/pkgsite. There is a mirror of the repository at github.com/golang/pkgsite.
To contribute, please read our contributing guide.
Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file.