Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ private static void writeDocsSkeleton(
.orElse(context.settings().service().getName()));
writeConf(settings, context, projectName);
writeIndexes(context, projectName);
writeDocsReadme(context);
writeMakeBat(context);
writeMakeFile(context);
}
Expand Down Expand Up @@ -447,6 +448,31 @@ private static void writeIndexes(GenerationContext context, String projectName)
writeIndexFile(context, "docs/models/index.rst", "Models");
}


/**
* Write the readme in the docs folder describing instructions for generation
*
* @param context The generation context containing the writer delegator.
*/
private static void writeDocsReadme(
GenerationContext context
) {
context.writerDelegator().useFileWriter("docs/README.md", writer -> {
writer.write("""
## Generating Documentation

Sphinx is used for documentation. You can generate HTML locally with the
following:

```
$$ uv pip install ".[docs]"
$$ cd docs
$$ make html
```
""");
});
}

/**
* Helper method to write an index file with the given title.
* This method creates an index file at the specified file path with the provided title.
Expand Down