-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add some notes on generating documentation
- Loading branch information
Showing
2 changed files
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
src/modules/developer-guide/pages/documentation/codegen.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). | ||
==== |