update doc dependencies, use furo theme (#2507)

.github/workflows/cicd.yml

@@ -90,7 +90,7 @@ jobs:
       - name: 🏗 Setup Python
         uses: finleyfamily/[email protected]
         with:
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
       - name: 🏗 Configure AWS Credentials
         uses: aws-actions/configure-aws-credentials@v4
         with:
@@ -126,7 +126,7 @@ jobs:
       - name: 🏗 Setup Python
         uses: finleyfamily/[email protected]
         with:
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
           python-version: ${{ matrix.python-version }}
       - name: ⤵️ Install Node Dependencies
         run: make npm-ci
@@ -167,7 +167,7 @@ jobs:
       - name: 🏗 Setup Python
         uses: finleyfamily/[email protected]
         with:
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
           python-version: '3.10'
       - name: ⤵️ Install Ubuntu Dependencies
         run: |
@@ -206,7 +206,7 @@ jobs:
       - name: 🏗 Setup Python
         uses: finleyfamily/[email protected]
         with:
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
           python-version: ${{ matrix.python-version }}
       - name: ⤵️ Install Node Dependencies
         run: make npm-install
@@ -239,7 +239,7 @@ jobs:
         uses: finleyfamily/[email protected]
         with:
           poetry-install: false
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
       # Remove apt repos that are known to break from time to time
       # See https://github.com/actions/virtual-environments/issues/323
       - name: Remove broken apt repos (ubuntu)

.github/workflows/on-push-pyinstaller.yml

@@ -39,7 +39,7 @@ jobs:
         uses: finleyfamily/[email protected]
         with:
           poetry-install: false
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
           python-version: ${{ matrix.python-version }}
       # Remove apt repos that are known to break from time to time
       # See https://github.com/actions/virtual-environments/issues/323
@@ -81,7 +81,7 @@ jobs:
         uses: finleyfamily/[email protected]
         with:
           poetry-install: false
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
           python-version: ${{ matrix.python-version }}
       # Remove apt repos that are known to break from time to time
       # See https://github.com/actions/virtual-environments/issues/323
@@ -130,7 +130,7 @@ jobs:
         uses: finleyfamily/[email protected]
         with:
           poetry-install: false
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
           python-version: ${{ matrix.python-version }}
       - name: 🏗 Setup Node
         uses: actions/setup-node@v4

.github/workflows/release.yml

@@ -32,7 +32,7 @@ jobs:
       - name: 🏗 Setup Python
         uses: finleyfamily/[email protected]
         with:
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
           python-version: ${{ matrix.python-version }}
       # Remove apt repos that are known to break from time to time
       # See https://github.com/actions/virtual-environments/issues/323
@@ -74,7 +74,7 @@ jobs:
       - name: 🏗 Setup Python
         uses: finleyfamily/[email protected]
         with:
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
           python-version: ${{ matrix.python-version }}
       # Remove apt repos that are known to break from time to time
       # See https://github.com/actions/virtual-environments/issues/323
@@ -116,7 +116,7 @@ jobs:
       - name: 🏗 Setup Python
         uses: finleyfamily/[email protected]
         with:
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
           python-version: ${{ matrix.python-version }}
       - name: 🏗 Setup Node
         uses: actions/setup-node@v4
@@ -204,7 +204,7 @@ jobs:
       - name: 🏗 Setup Python
         uses: finleyfamily/[email protected]
         with:
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
       # Remove apt repos that are known to break from time to time
       # See https://github.com/actions/virtual-environments/issues/323
       - name: Remove broken apt repos (ubuntu)
@@ -238,7 +238,7 @@ jobs:
         uses: finleyfamily/[email protected]
         with:
           poetry-install: false
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
       - name: 🚀 Publish Distribution 📦 to PyPI
         env:
           POETRY_PYPI_TOKEN_PYPI: ${{ secrets.pypi_password }}
@@ -294,7 +294,7 @@ jobs:
       - name: 🏗 Setup Python
         uses: finleyfamily/[email protected]
         with:
-          poetry-plugins: poetry-dynamic-versioning
+          poetry-plugins: poetry-dynamic-versioning[plugin]
       - name: 🏗 Configure AWS Credentials
         uses: aws-actions/configure-aws-credentials@v4
         with:

.readthedocs.yml

@@ -18,7 +18,7 @@ build:
       # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
       # VIRTUAL_ENV needs to be set manually for now.
       # See https://github.com/readthedocs/readthedocs.org/pull/11152/
-      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs,types
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

.vscode/cspell.json

@@ -105,6 +105,7 @@
         "codecov",
         "configvars",
         "copydir",
+        "datetimez",
         "devel",
         "dockerized",
         "domparator",
@@ -115,6 +116,7 @@
         "ekscluster",
         "eksservicerole",
         "EOCD",
+        "errmsg",
         "excinfo",
         "execglobals",
         "Fakhreddine",
@@ -128,6 +130,7 @@
         "FQDNs",
         "frontmatter",
         "fstring",
+        "furo",
         "getgid",
         "getpreferredencoding",
         "getuid",
@@ -139,6 +142,7 @@
         "humanreadable",
         "identless",
         "igittigitt",
+        "Inconsolata",
         "indentless",
         "instancerole",
         "intersphinx",
@@ -184,6 +188,7 @@
         "prehook",
         "prepad",
         "prevdir",
+        "pyupgrade",
         "PYXMLSEC",
         "readacl",
         "refreshable",
@@ -222,20 +227,17 @@
         "tmpdirname",
         "tomap",
         "tomli",
+        "tomlsort",
         "topdown",
+        "troyready",
+        "tryceratops",
         "typehints",
         "typeshed",
         "unittests",
         "unsubscriptable",
         "usefixtures",
         "viewcode",
         "writeacl",
-        "xmlsec",
-        "troyready",
-        "tomlsort",
-        "pyupgrade",
-        "tryceratops",
-        "errmsg",
-        "datetimez"
+        "xmlsec"
     ]
 }

docs/source/_static/scripts/custom.js

@@ -0,0 +1,4 @@
+// open external links in new tabs
+$(document).ready(function () {
+  $('a.external').attr('target', '_blank');
+});

docs/source/cdk/advanced_features.rst

@@ -7,9 +7,6 @@ Advanced Features
 Advanced features and detailed information for using CDK with Runway.
 
 
-.. contents::
-  :depth: 4
-
 
 .. _cdk.Build Steps:
 

docs/source/cdk/configuration.rst

@@ -6,8 +6,6 @@ Configuration
 
 Standard `CDK <https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html>`__ rules apply but, we have some added prerequisites, recommendations, and caveats.
 
-.. contents::
-  :depth: 4
 
 
 *************

docs/source/cdk/directory_structure.rst

@@ -7,9 +7,6 @@ Directory Structure
 Example directory structures for a CDK module.
 
 
-.. contents::
-  :depth: 4
-
 
 **********
 C# Example

docs/source/cfngin/blueprints.rst

@@ -9,7 +9,7 @@ Blueprints
 ##########
 
 A |Blueprint| is a python classes that dynamically builds CloudFormation templates.
-Where you would specify a raw Cloudformation template in a |stack| using the |template_path| key, you instead specify a |Blueprint| subclass using the |class_path| key.
+Where you would specify a raw Cloudformation template in a |Stack| using the |template_path| key, you instead specify a |Blueprint| subclass using the |class_path| key.
 
 Traditionally Blueprints are built using troposphere_, but that is not absolutely necessary.
 
@@ -28,9 +28,6 @@ In the end, all that is required is that the |Blueprint| is a subclass of :class
       """
 
 
-.. contents::
-  :depth: 4
-
 
 *********
 Variables
@@ -81,7 +78,7 @@ TroposphereType
 ===============
 
 The :class:`~runway.cfngin.blueprints.variables.types.TroposphereType` can be used to generate resources for use in the :class:`~runway.cfngin.blueprints.base.Blueprint` directly from user-specified configuration.
-Which of the below case applies depends on what ``defined_type`` was chosen, and how it would be normally used in the :ref:`Blueprint <term-blueprint>` (and CloudFormation in general).
+Which of the below case applies depends on what ``defined_type`` was chosen, and how it would be normally used in the :term:`Blueprint` (and :link:`CloudFormation` in general).
 
 Resource Types
 --------------
@@ -306,7 +303,7 @@ To use this in your |Blueprint|, you can get the name from context using ``self.
 Referencing the Stack short name
 ================================
 
-The |Stack| short name is the name you specified for the |stack| within your YAML config.
+The |Stack| short name is the name you specified for the |Stack| within your YAML config.
 It does not include the |namespace|.
 If your CFNgin namespace is ``CFNginIsCool`` and the stack's short name is ``myAwesomeEC2Instance``, the short name would be ``myAwesomeEC2Instance``.
 

docs/source/cfngin/configuration.rst

@@ -15,9 +15,6 @@ In addition to the :ref:`Runway Config File <runway-config>`, there are two file
   It has been replaced with an internal CloudFormation engin (CFNgin).
 
 
-.. contents::
-  :depth: 4
-
 
 **********
 runway.yml
@@ -48,10 +45,10 @@ CloudFormation modules do not have any module-specific options.
 Parameters
 ==========
 
-Runway can pass :ref:`Parameters <term-param>` to a CloudFormation module in place of or in addition to values in an :ref:`environment file <cfngin-env>`.
-When :ref:`Parameters <term-param>` are passed to the module, the data type is retained (e.g. ``array``, ``boolean``, ``mapping``).
+Runway can pass :term:`Parameters` to a CloudFormation module in place of or in addition to values in an :ref:`environment file <cfngin-env>`.
+When :term:`Parameters` are passed to the module, the data type is retained (e.g. ``array``, ``boolean``, ``mapping``).
 
-A typical usage pattern would be to use :ref:`Runway Lookups <Lookups>` in combination with :ref:`Parameters <term-param>` to pass :ref:`deploy environment <term-deploy-env>` and/or region specific values to the module from the :ref:`Runway Config File <runway-config>`.
+A typical usage pattern would be to use :ref:`Runway Lookups <Lookups>` in combination with :term:`Parameters` to pass :term:`Deploy Environment` and/or region specific values to the module from the :ref:`Runway Config File <runway-config>`.
 
 .. rubric:: Example
 .. code-block:: yaml
@@ -68,7 +65,7 @@ A typical usage pattern would be to use :ref:`Runway Lookups <Lookups>` in combi
 Common Parameters
 -----------------
 
-Runway automatically makes the following commonly used :ref:`Parameters <term-param>`  available to CloudFormation modules.
+Runway automatically makes the following commonly used :term:`Parameters`  available to CloudFormation modules.
 
 .. note::
   If these parameters are already being explicitly defined in :attr:`deployment.parameters`/:attr:`module.parameters` the value provided will be used instead of what would be automatically added.
@@ -77,7 +74,7 @@ Runway automatically makes the following commonly used :ref:`Parameters <term-pa
   :type: str
   :noindex:
 
-  Taken from the ``DEPLOY_ENVIRONMENT`` environment variable. This will the be current :ref:`deploy environment <term-deploy-env>`.
+  Taken from the ``DEPLOY_ENVIRONMENT`` environment variable. This will the be current :term:`Deploy Environment`.
 
 .. data:: region
   :type: str
@@ -259,7 +256,7 @@ Top-Level Fields
     In addition, this value can be used to create an S3 bucket that will be used to upload and store all CloudFormation templates.
     See :attr:`~cfngin.config.cfngin_bucket` for more detailed information.
 
-    In general, this is paired with the concept of :ref:`deploy environments <term-deploy-env>` to create a namespace per environment.
+    In general, this is paired with the concept of :term:`Deploy Environments <Deploy Environment>` to create a namespace per environment.
 
     .. rubric:: Example
     .. code-block:: yaml
@@ -816,8 +813,8 @@ Using Outputs as Variables
 ---------------------------
 
 Since CFNgin encourages the breaking up of your CloudFormation stacks into entirely separate stacks, sometimes you'll need to pass values from one stack to another.
-The way this is handled in CFNgin is by having one stack provide :ref:`Outputs <term-outputs>` for all the values that another stack may need, and then using those as the inputs for another stack's :attr:`~cfngin.stack.variables`.
-CFNgin makes this easier for you by providing a syntax for :attr:`~cfngin.stack.variables` that will cause CFNgin to automatically look up the values of :ref:`Outputs <term-outputs>` from another stack in its config.
+The way this is handled in CFNgin is by having one stack provide :term:`Outputs <Output>` for all the values that another stack may need, and then using those as the inputs for another stack's :attr:`~cfngin.stack.variables`.
+CFNgin makes this easier for you by providing a syntax for :attr:`~cfngin.stack.variables` that will cause CFNgin to automatically look up the values of :term:`Outputs <Output>` from another stack in its config.
 
 To do so, use the :ref:`output lookup` in the :attr:`~cfngin.stack.variables` on the target stack.
 
@@ -886,16 +883,16 @@ A pretty common use case is to have separate environments that you want to look
 For example, you might want a **production** and a **staging** environment.
 
 The production environment likely needs more instances, and often those instances will be of a larger instance type.
-The parameters defined in an environment file, :attr:`deployment.parameters`, and/or :attr:`module.parameters` allow you to use your existing CFNgin config, but provide different values based on the current :ref:`deploy environment <term-deploy-env>`.
+The parameters defined in an environment file, :attr:`deployment.parameters`, and/or :attr:`module.parameters` allow you to use your existing CFNgin config, but provide different values based on the current :term:`Deploy Environment`.
 
 .. rubric:: Example
 .. code-block:: yaml
 
   vpcID: vpc-12345678
 
-Provided the key-value pair above, you will now be able to use this in your configs for a :ref:`deploy environment <term-deploy-env>`.
+Provided the key-value pair above, you will now be able to use this in your configs for a :term:`Deploy Environment`.
 They act as keys that can be used in your config file, providing a sort of templating ability.
-This allows you to change the values of your config based on the current :ref:`deploy environment <term-deploy-env>`.
+This allows you to change the values of your config based on the current :term:`Deploy Environment`.
 
 For example, if you have a **webserver** stack, and you need to provide it a variable for the instance size it should use, you would have something like this in your config file.
 

docs/source/cfngin/directory_structure.rst

@@ -6,8 +6,6 @@ Directory Structure
 
 Example directory structures for a CloudFormation module.
 
-.. contents::
-  :depth: 4
 
 
 **********

docs/source/cfngin/hooks/awslambda.PythonFunction.rst

@@ -24,10 +24,6 @@ It also ensures that binary files built during the install process are compatibl
 .. versionadded:: 2.5.0
 
 
-.. contents:: Table of Contents
-  :local:
-
-
 
 ****
 Args

docs/source/cfngin/hooks/awslambda.PythonLayer.rst

@@ -22,10 +22,6 @@ It also ensures that binary files built during the install process are compatibl
 .. versionadded:: 2.5.0
 
 
-.. contents:: Table of Contents
-  :local:
-
-
 
 ****
 Args