Skip to content

Commit 4190395

Browse files
committed
Add docs README
1 parent 89f37d3 commit 4190395

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

codegen/core/src/main/java/software/amazon/smithy/python/codegen/generators/SetupGenerator.java

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,6 @@ private static void writeDocsSkeleton(
288288
.orElse(context.settings().service().getName()));
289289
writeConf(settings, context, projectName);
290290
writeIndexes(context, projectName);
291-
writeDocsReadme(context);
292291
writeMakeBat(context);
293292
writeMakeFile(context);
294293
}
@@ -450,26 +449,31 @@ private static void writeIndexes(GenerationContext context, String projectName)
450449

451450

452451
/**
453-
* Write the readme in the docs folder describing instructions for generation
452+
* Write a Makefile.
453+
* A Makefile is used on Unix-based systems to build Sphinx documentation.
454+
* This file contains rules for cleaning the build directory and generating HTML documentation.
454455
*
455456
* @param context The generation context containing the writer delegator.
456457
*/
457458
private static void writeDocsReadme(
458459
GenerationContext context
459460
) {
460-
context.writerDelegator().useFileWriter("docs/README.md", writer -> {
461-
writer.write("""
461+
context.writerDelegator().useFileWriter("docs/README.", "", writer -> {
462+
writer.write("""
463+
# Documentation
464+
462465
## Generating Documentation
463466
464467
Sphinx is used for documentation. You can generate HTML locally with the
465468
following:
466469
467470
```
468-
$$ uv pip install ".[docs]"
469-
$$ cd docs
470-
$$ make html
471+
$ uv pip install ".[docs]"
472+
$ cd docs
473+
$ make html
471474
```
472-
""");
475+
476+
""");
473477
});
474478
}
475479

0 commit comments

Comments
 (0)