Generate docs for structures and members #9
Merged
Conversation
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
dirhtml is nice when you have a host doing automatic redrirects from `/` to `/index.html` but it's less nice otherwise. This changes the default back to regular html output. When integration config is added to Smithy, this will be one of the configuration options.
kstich
requested changes
Oct 30, 2023
smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/DirectedDocGen.java
Outdated
Show resolved
Hide resolved
smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/SmithyDocPlugin.java
Outdated
Show resolved
Hide resolved
...cgen-core/src/main/java/software/amazon/smithy/docgen/core/sections/ShapeMembersSection.java
Outdated
Show resolved
Hide resolved
...gen-core/src/main/java/software/amazon/smithy/docgen/core/generators/StructureGenerator.java
Show resolved
Hide resolved
This adds a validation step to the plugin that runs the IO structure reuse validator at the danger level, adding some additional context for how it impacts docs specifically. This also removes the invocation to always create dedicated input and output shapes.
kstich
approved these changes
Nov 2, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds documentation generation for structures and members. It also adds in the capability to write reference links using the
$Rformatter, which is used when writing member types, and write out referenceable anchors. The sphinx formatting for this was kept as close to base commonmark as possible. It also changes the default sphinx output to behtmlinstead ofdirhtmlbecause it's much harder to inspect thedirhtmloutput locally. And finally, it adds in placeholder docs for shapes without docs since writing nothing can break formatting. Below is a screenshot of an example page:By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.