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.
smithy-lang · Apr 10, 2023 · 75e4b4d · 75e4b4d
1 parent 37170e3
commit 75e4b4d
Show file tree

Hide file tree

Showing 6 changed files with 535 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -6,7 +6,7 @@
 
 # -- General configuration ------------------------------------------------
 
-extensions = ['sphinx_copybutton', 'smithy']
+extensions = ['sphinx_copybutton', 'sphinx_substitution_extensions', 'smithy']
 templates_path = ['../_templates', '../root-redirects']
 
 pygments_style = "default"

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -4,6 +4,7 @@ furo==2022.6.21
 
 # Used by new docs.
 sphinx-inline-tabs==2022.1.2b11
+Sphinx-Substitution-Extensions==2022.2.16
 
 # Use by old docs.
 sphinx-tabs==3.2.0

diff --git a/docs/source-2.0/guides/building-models/gradle-plugin.rst b/docs/source-2.0/guides/building-models/gradle-plugin.rst
@@ -1,3 +1,5 @@
+.. _smithy-gradle-plugin:
+
 ====================
 Smithy Gradle Plugin
 ====================

diff --git a/docs/source-2.0/guides/index.rst b/docs/source-2.0/guides/index.rst
@@ -5,6 +5,7 @@ Guides
 .. toctree::
     :maxdepth: 1
 
+    smithy-cli/index
     building-models/index
     using-code-generation/index
     model-linters