~oliverpool/log.pfad.fr

3c09345b727562338c2dd8127af073bca3ab6125 — oliverpool a month ago 843ff0f
vanitydoc: update with latest dev
1 files changed, 2 insertions(+), 3 deletions(-)

M content/2022-12-02-vanitydoc.gmi
M content/2022-12-02-vanitydoc.gmi => content/2022-12-02-vanitydoc.gmi +2 -3
@@ 44,10 44,9 @@ code.pfad.fr/risefront

## Basic usage

To generate the documentation for a module, simply list the packages using `go list -json` and pipe them to `vanitydoc`:
To generate the documentation for a module, simply call `vanitydoc` (it does not rely on `go list` since March 2023):

```
go list -json="Dir,ImportPath,Doc,Module" ./... | \
go run code.pfad.fr/vanitydoc@latest -html=dist/html -gemtext=dist/gmi gitea://codeberg.org/pfad.fr/risefront
```



@@ 59,7 58,7 @@ go run code.pfad.fr/vanitydoc@latest -html=dist/html -gemtext=dist/gmi gitea://c

I am currently happy of this package and plan to use it as-is. It could be improved in multiple ways, however I didn't find an elegant solution to the following problems yet:

* Listing the packages currently requires the go toolchain. Figure out a way to compile "go list" inside the package.
* Listing the packages currently requires the go toolchain. Figure out a way to compile "go list" inside the package (done in March 2023).
* The generated documentation is for the current build tags. Generate all sets of builds tags under specific URLs.
* Document the version which was used to generate the documentation (golang.org/x/tools/go/vcs package is missing cmd/go/internal/vcs.Cmd.Status)