Skip to content
Open
Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ jobs:
activate-environment: true
enable-cache: true

- name: Install pandoc
uses: pandoc/actions/setup@86321b6dd4675f5014c611e05088e10d4939e09e
with:
version: 3.8.2

- name: Setup workspace
run: |
make install
Expand Down
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,13 @@ With both files your project directory should look like this:

The code generator libraries have not been published yet, so
you'll need to build it yourself. To build and run the generator, you will need
the following prerequisites:
the following prerequisites installed in your environment:

* [uv](https://docs.astral.sh/uv/)
* The [Smithy CLI](https://smithy.io/2.0/guides/smithy-cli/cli_installation.html)
* JDK 17 or newer
* make
* [pandoc](https://pandoc.org/installing.html) CLI

This project uses [uv](https://docs.astral.sh/uv/) for managing all things python.
Once you have it installed, run the following command to check that it's ready to use:
Expand Down Expand Up @@ -169,6 +170,16 @@ if __name__ == "__main__":
asyncio.run(main())
```

#### pandoc CLI

Smithy [documentation traits](https://smithy.io/2.0/spec/documentation-traits.html#documentation-trait) are modeled in one of two formats:

- **Raw HTML** for AWS services
- **CommonMark** for all other Smithy-based services (may include embedded HTML)

The code generator uses [pandoc](https://pandoc.org/) to normalize and convert this
content into Markdown suitable for Google-style Python docstrings.

#### Is Java really required?

Only for now. Once the generator has been published, the Smithy CLI will be able
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,3 @@ software.amazon.smithy.python.aws.codegen.AwsProtocolsIntegration
software.amazon.smithy.python.aws.codegen.AwsServiceIdIntegration
software.amazon.smithy.python.aws.codegen.AwsUserAgentIntegration
software.amazon.smithy.python.aws.codegen.AwsStandardRegionalEndpointsIntegration
software.amazon.smithy.python.aws.codegen.AwsRstDocFileGenerator

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ dependencies {
testRuntimeOnly(libs.junit.jupiter.engine)
testRuntimeOnly(libs.junit.platform.launcher)
testImplementation(libs.junit.jupiter.params)
testImplementation(libs.mockito.core)
compileOnly("com.github.spotbugs:spotbugs-annotations:${spotbugs.toolVersion.get()}")
testCompileOnly("com.github.spotbugs:spotbugs-annotations:${spotbugs.toolVersion.get()}")
}
Expand Down
2 changes: 0 additions & 2 deletions codegen/core/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,4 @@ dependencies {
implementation(libs.smithy.protocol.test.traits)
// We have this because we're using RestJson1 as a 'generic' protocol.
implementation(libs.smithy.aws.traits)
implementation(libs.jsoup)
implementation(libs.commonmark)
}
Loading
Loading