From 1ade5da66157bbaa16f7abda2c829fc438591cb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Toma=C5=BE=20Jerman?= Date: Tue, 27 Feb 2024 11:20:15 +0100 Subject: [PATCH] Add some notes on generating documentation --- src/modules/developer-guide/nav.adoc | 1 + .../pages/documentation/codegen.adoc | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 src/modules/developer-guide/pages/documentation/codegen.adoc diff --git a/src/modules/developer-guide/nav.adoc b/src/modules/developer-guide/nav.adoc index 814ec9b8..05b14fa5 100644 --- a/src/modules/developer-guide/nav.adoc +++ b/src/modules/developer-guide/nav.adoc @@ -1,6 +1,7 @@ * xref:index.adoc[] ** xref:documentation/index.adoc[] +*** xref:documentation/codegen.adoc[] *** xref:documentation/annotations.adoc[] *** xref:documentation/examples/index.adoc[] *** xref:documentation/changelog.adoc[] diff --git a/src/modules/developer-guide/pages/documentation/codegen.adoc b/src/modules/developer-guide/pages/documentation/codegen.adoc new file mode 100644 index 00000000..4f0d1cf4 --- /dev/null +++ b/src/modules/developer-guide/pages/documentation/codegen.adoc @@ -0,0 +1,18 @@ +include::ROOT:partial$variables.adoc[] + += Generating Code + +To generate documentation you need two commands (at some point we'll deprecate the legacy one): + +```bash +DOCS_DIR=../path/to/docs/repo make codegen +``` + +```bash +make codegen-legacy && ~/go/bin/corteza-codegen -d ../path/to/docs/repo +``` + +[NOTE] +==== +The second command is sub optimal, but at this point I'm not entirely sure how to do it in one go (how to pass the `-d` flag to the called command). +====