mirror of
https://github.com/siderolabs/talos.git
synced 2025-08-18 04:27:06 +02:00
d0ed6d7cc6
Comments encoding works, defaults encoding works. Docgen was revamped: now it generates go files. While markdown files are all handled by `pkg/machinery/config/encoder/markdown.go`. Changed scheme for docs. Now it no longer relies on a single `doc.go` in the root of a package. Instead it can generate separate `*_doc.go` files for each file in the package. `docgen` now expects to get 3 params instead of 2. 3rd parameter is used to define a unique method name for getting the list of structs in the file. Backward compatibility is supported if we define package name as the 3rd parameter. 1st parameter no longer scans whole current directory, instead it points to the particular file that should be processed by docgen. `talosctl docs` command now supports two flags: `--config` and `--cli`. They allow generating only docs for v1alpha1 configs or for talosctl. If no flags are defined, all docs are generated. Additionally made field types clickable in the output markdown file. Signed-off-by: Artem Chernyshev <artem.0xD2@gmail.com>
9 lines
139 B
Modula-2
9 lines
139 B
Modula-2
module github.com/talos-systems/docgen
|
|
|
|
go 1.13
|
|
|
|
require (
|
|
gopkg.in/yaml.v2 v2.2.5
|
|
mvdan.cc/gofumpt v0.0.0-20200927160801-5bfeb2e70dd6
|
|
)
|