Skip to content

Commit 75e4b4d

Browse files
authored
Create Smithy-CLI installation guide (#1697)
Add smithy-cli guide section and install guide As part of the official Smithy-CLI release, we need a guide on how to install it for each supported platform. A new guide section is also added for CLI-specific guides (coming soon). A verification guide is also written, so users can verify their installation.
1 parent 37170e3 commit 75e4b4d

File tree

6 files changed

+535
-1
lines changed

6 files changed

+535
-1
lines changed

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# -- General configuration ------------------------------------------------
88

9-
extensions = ['sphinx_copybutton', 'smithy']
9+
extensions = ['sphinx_copybutton', 'sphinx_substitution_extensions', 'smithy']
1010
templates_path = ['../_templates', '../root-redirects']
1111

1212
pygments_style = "default"

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ furo==2022.6.21
44

55
# Used by new docs.
66
sphinx-inline-tabs==2022.1.2b11
7+
Sphinx-Substitution-Extensions==2022.2.16
78

89
# Use by old docs.
910
sphinx-tabs==3.2.0

docs/source-2.0/guides/building-models/gradle-plugin.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _smithy-gradle-plugin:
2+
13
====================
24
Smithy Gradle Plugin
35
====================

docs/source-2.0/guides/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Guides
55
.. toctree::
66
:maxdepth: 1
77

8+
smithy-cli/index
89
building-models/index
910
using-code-generation/index
1011
model-linters

0 commit comments

Comments
 (0)