Skip to content

Commit fd4368a

Browse files
committed
Remove Mkdocs stub file generation
1 parent 2c47760 commit fd4368a

File tree

26 files changed

+95
-1114
lines changed

26 files changed

+95
-1114
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
enable-cache: true
4040

4141
- name: Install pandoc
42-
uses: pandoc/actions/setup@v1
42+
uses: pandoc/actions/setup@86321b6dd4675f5014c611e05088e10d4939e09e
4343
with:
4444
version: 3.8.2
4545

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,13 @@ if __name__ == "__main__":
172172

173173
#### pandoc CLI
174174

175-
The code generator uses [pandoc](https://pandoc.org/) to convert documentation from Smithy models
176-
into Markdown format for Python docstrings, which can then be used to generate
177-
documentation with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/).
175+
Smithy [documentation traits](https://smithy.io/2.0/spec/documentation-traits.html#documentation-trait) are modeled in one of two formats:
176+
177+
- **Raw HTML** for AWS services
178+
- **CommonMark** for all other Smithy-based services (may include embedded HTML)
179+
180+
The code generator uses [pandoc](https://pandoc.org/) to normalize and convert this
181+
content into Markdown suitable for Google-style Python docstrings.
178182

179183
#### Is Java really required?
180184

codegen/aws/core/src/it/java/software/amazon/smithy/python/codegen/test/AwsCodegenTest.java

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
*/
55
package software.amazon.smithy.python.codegen.test;
66

7-
import static org.junit.jupiter.api.Assertions.assertTrue;
8-
9-
import java.nio.file.Files;
107
import java.nio.file.Path;
118
import org.junit.jupiter.api.Test;
129
import org.junit.jupiter.api.io.TempDir;
@@ -17,8 +14,7 @@
1714
import software.amazon.smithy.python.codegen.PythonClientCodegenPlugin;
1815

1916
/**
20-
* Simple test that executes the Python client codegen plugin for an AWS-like service
21-
* and validates that MkDocs documentation files are generated.
17+
* Simple test that executes the Python client codegen plugin for an AWS-like service.
2218
*/
2319
public class AwsCodegenTest {
2420

@@ -40,20 +36,6 @@ public void testCodegen(@TempDir Path tempDir) {
4036
.model(model)
4137
.build();
4238
plugin.execute(context);
43-
44-
// Verify MkDocs documentation files are generated for AWS services
45-
Path docsDir = tempDir.resolve("docs");
46-
assertTrue(Files.exists(docsDir), "docs directory should be created");
47-
48-
Path indexFile = docsDir.resolve("index.md");
49-
assertTrue(Files.exists(indexFile), "index.md should be generated for AWS services");
50-
51-
Path operationsDir = docsDir.resolve("operations");
52-
assertTrue(Files.exists(operationsDir), "operations directory should be created");
53-
54-
// Verify at least one operation file exists
55-
Path basicOperationFile = operationsDir.resolve("basic_operation.md");
56-
assertTrue(Files.exists(basicOperationFile), "basic_operation.md should be generated");
5739
}
5840

5941
}

0 commit comments

Comments
 (0)