Skip to content

Commit

Permalink
Add some notes on generating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tjerman committed Feb 27, 2024
1 parent 57806e8 commit 1ade5da
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/modules/developer-guide/nav.adoc
Original file line number Diff line number Diff line change
@@ -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[]
Expand Down
18 changes: 18 additions & 0 deletions src/modules/developer-guide/pages/documentation/codegen.adoc
Original file line number Diff line number Diff line change
@@ -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).
====

0 comments on commit 1ade5da

Please sign in to comment.