Deployed 3d1682c to main with MkDocs 1.6.1 and mike 2.1.3

main/CHANGELOG/index.html

@@ -523,13 +523,13 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#110rc1" class="md-nav__link">
+  <a href="#110" class="md-nav__link">
     <span class="md-ellipsis">
-      1.1.0rc1
+      1.1.0
     </span>
   </a>
 
-    <nav class="md-nav" aria-label="1.1.0rc1">
+    <nav class="md-nav" aria-label="1.1.0">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -542,18 +542,18 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#110rc1-deprecation-notices" class="md-nav__link">
+  <a href="#110-deprecation-notices" class="md-nav__link">
     <span class="md-ellipsis">
-      1.1.0rc1 Deprecation Notices
+      1.1.0 Deprecation Notices
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#110rc1-breaking-changes" class="md-nav__link">
+  <a href="#110-breaking-changes" class="md-nav__link">
     <span class="md-ellipsis">
-      1.1.0rc1 Breaking Changes
+      1.1.0 Breaking Changes
     </span>
   </a>
 
@@ -2635,13 +2635,13 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#110rc1" class="md-nav__link">
+  <a href="#110" class="md-nav__link">
     <span class="md-ellipsis">
-      1.1.0rc1
+      1.1.0
     </span>
   </a>
 
-    <nav class="md-nav" aria-label="1.1.0rc1">
+    <nav class="md-nav" aria-label="1.1.0">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -2654,18 +2654,18 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#110rc1-deprecation-notices" class="md-nav__link">
+  <a href="#110-deprecation-notices" class="md-nav__link">
     <span class="md-ellipsis">
-      1.1.0rc1 Deprecation Notices
+      1.1.0 Deprecation Notices
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#110rc1-breaking-changes" class="md-nav__link">
+  <a href="#110-breaking-changes" class="md-nav__link">
     <span class="md-ellipsis">
-      1.1.0rc1 Breaking Changes
+      1.1.0 Breaking Changes
     </span>
   </a>
 
@@ -2992,14 +2992,14 @@
 
 
 <h1 id="aries-cloud-agent-python-changelog">Aries Cloud Agent Python Changelog<a class="headerlink" href="#aries-cloud-agent-python-changelog" title="Permanent link">&para;</a></h1>
-<h2 id="110rc1">1.1.0rc1<a class="headerlink" href="#110rc1" title="Permanent link">&para;</a></h2>
+<h2 id="110">1.1.0<a class="headerlink" href="#110" title="Permanent link">&para;</a></h2>
 <h3 id="october-15-2024">October 15, 2024<a class="headerlink" href="#october-15-2024" title="Permanent link">&para;</a></h3>
 <p>Release 1.1.0 is the first release of ACA-Py from the <a href="https://openwallet.foundation/">OpenWallet Foundation</a> (OWF). The only reason for the release is to test out all of the release publishing actions now that we have moved the repo to its new home (<a href="https://github.com/openwallet-foundation/acapy">https://github.com/openwallet-foundation/acapy</a>). Almost all of the changes in the release are related to the move.</p>
 <p>The move triggered some big changes for those with existing ACA-Py deployments resulting from the change in the GitHub organization (from Hyperledger to OWF) and source code name (from <code>aries_cloudagent</code> to <code>acapy_agent</code>). See the <a href="#110rc0-breaking-changes">Release 1.1.0 breaking changes</a> for the details.</p>
 <p>For up to date details on what the repo move means for ACA-Py users, including steps for updating deployments, please follow the updates in <a href="https://github.com/hyperledger/aries-cloudagent-python/issues/3250">GitHub Issue #3250</a>. We'll keep you informed about the approach, timeline, and progress of the move. Stay tuned!</p>
-<h3 id="110rc1-deprecation-notices">1.1.0rc1 Deprecation Notices<a class="headerlink" href="#110rc1-deprecation-notices" title="Permanent link">&para;</a></h3>
+<h3 id="110-deprecation-notices">1.1.0 Deprecation Notices<a class="headerlink" href="#110-deprecation-notices" title="Permanent link">&para;</a></h3>
 <p>The same <strong><a href="#101-deprecation-notices">deprecation notices</a></strong> from the <a href="#101">1.0.1</a> release about AIP 1.0 protocols still apply. The protocols remain in the 1.1.0 release, but will be moved out of the core and into plugins soon. Please review these notifications carefully!</p>
-<h3 id="110rc1-breaking-changes">1.1.0rc1 Breaking Changes<a class="headerlink" href="#110rc1-breaking-changes" title="Permanent link">&para;</a></h3>
+<h3 id="110-breaking-changes">1.1.0 Breaking Changes<a class="headerlink" href="#110-breaking-changes" title="Permanent link">&para;</a></h3>
 <p>The only (but significant) breaking changes in 1.1.0 are related to the GitHub organization and project name changes. Specific impacts are:</p>
 <ul>
 <li>the renaming of the source code folder from <code>aries_cloudagent</code> to <code>acapy_agent</code>,</li>
@@ -3015,7 +3015,7 @@ <h3 id="110rc1-breaking-changes">1.1.0rc1 Breaking Changes<a class="headerlink"
 <li>Deployments sourcing the ACA-Py published container image artifacts to <a href="https://ghcr.io">GHCR</a> must update their deployments to use the new URLs.</li>
 </ul>
 <p>Please note that if and when the current LTS releases (0.11 and 0.12) have new releases, they will continue to use the <code>aries_cloudagent</code> source folder, the existing locations for the <a href="https://pypi.org">PyPi</a> and <a href="https://ghcr.io">GHCR</a> container image artifacts.</p>
-<h4 id="110rc1-categorized-list-of-pull-requests">1.1.0rc1 Categorized List of Pull Requests<a class="headerlink" href="#110rc1-categorized-list-of-pull-requests" title="Permanent link">&para;</a></h4>
+<h4 id="110-categorized-list-of-pull-requests">1.1.0 Categorized List of Pull Requests<a class="headerlink" href="#110-categorized-list-of-pull-requests" title="Permanent link">&para;</a></h4>
 <ul>
 <li>
 <p>Updates related to the move and rename of the repository from the Hyperledger to <a href="https://openwallet.foundation/">OpenWallet Foundation</a> GitHub organization</p>
@@ -3030,6 +3030,7 @@ <h4 id="110rc1-categorized-list-of-pull-requests">1.1.0rc1 Categorized List of P
 <li>
 <p>Release management pull requests:</p>
 <ul>
+<li>1.1.0 <a href="https://github.com/openwallet-foundation/acapy/pull/3292">#3294</a> <a href="https://github.com/swcurran">swcurran</a></li>
 <li>1.1.0rc1 <a href="https://github.com/openwallet-foundation/acapy/pull/3292">#3292</a> <a href="https://github.com/swcurran">swcurran</a></li>
 <li>1.1.0rc0 <a href="https://github.com/openwallet-foundation/acapy/pull/3284">#3284</a> <a href="https://github.com/swcurran">swcurran</a></li>
 </ul>

main/Managing-ACA-Py-Doc-Site/index.html

@@ -2400,7 +2400,7 @@ <h2 id="generation-process">Generation Process<a class="headerlink" href="#gener
 and mkdocs configuration.</p>
 <p>When the GitHub Action fires, it runs a container that carries out the following steps:</p>
 <ul>
-<li>Checks out the triggering branch, either <code>main</code> or <code>docs-v&lt;version&gt;</code> (e.g <code>docs-v1.1.0rc1</code>).</li>
+<li>Checks out the triggering branch, either <code>main</code> or <code>docs-v&lt;version&gt;</code> (e.g <code>docs-v1.1.0</code>).</li>
 <li>Runs the script <a href="https://github.com/openwallet-foundation/acapy/blob/main/scripts/prepmkdocs.sh">scripts/prepmkdocs.sh</a>, which moves and updates some of the
   markdown files so that they fit into the generated site. See the comments in
   the scripts for details about the copying and editing done via the script. In
@@ -2471,7 +2471,7 @@ <h2 id="removing-rc-releases-from-the-generated-site">Removing RC Releases From
 <li>Check your <code>git status</code> and make sure there are no changes in the branch --
   e.g., new files that shouldn't be added to the <code>gh-pages</code> branch. If there are
   any -- delete the files so they are not added.</li>
-<li>Remove the folder for the RC.  For example <code>rm -rf 1.1.0rc1</code></li>
+<li>Remove the folder for the RC.  For example <code>rm -rf 1.1.0</code></li>
 <li>Edit the <code>versions.json</code> file and remove the reference to the RC release in
   the file.</li>
 <li>Push the changes via a PR to the ACA-Py <code>gh-pages</code> branch (don't PR them into

main/PUBLISHING/index.html

@@ -2282,7 +2282,7 @@ <h1 id="how-to-publish-a-new-version">How to Publish a New Version<a class="head
 <p>Once ready to do a release, create a local branch that includes the following updates:</p>
 <ol>
 <li>
-<p>Create a local PR branch from an updated <code>main</code> branch, e.g. "1.1.0rc1".</p>
+<p>Create a local PR branch from an updated <code>main</code> branch, e.g. "1.1.0".</p>
 </li>
 <li>
 <p>See if there are any Document Site <code>mkdocs</code> changes needed. Run the script
@@ -2411,7 +2411,7 @@ <h1 id="how-to-publish-a-new-version">How to Publish a New Version<a class="head
 <ol>
 <li>
 <p>When a new release is tagged, create a new branch at the same commit with
-    the branch name in the format <code>docs-v&lt;version&gt;</code>, for example, <code>docs-v1.1.0rc1</code>.
+    the branch name in the format <code>docs-v&lt;version&gt;</code>, for example, <code>docs-v1.1.0</code>.
     The creation of the branch triggers the execution of the <a href="https://github.com/openwallet-foundation/acapy/blob/main/.github/workflows/publish-docs.yml">publish-docs</a>
     GitHub Action which generates the documentation for the new release,
     publishing it at <a href="https://aca-py.org">https://aca-py.org</a>. The GitHub Action also executes when

main/UpdateRTD/index.html

@@ -2459,15 +2459,16 @@ <h3 id="before-you-start">Before you start<a class="headerlink" href="#before-yo
 <a href="https://pypi.org/project/sphinx-rtd-theme/">Sphinx RTD theme</a>. Follow the instructions on the respective pages to install
 and verify the installation on your system.</p>
 <h3 id="generate-module-files">Generate Module Files<a class="headerlink" href="#generate-module-files" title="Permanent link">&para;</a></h3>
-<p>To rebuild the project and settings from scratch (you'll need to move the generated index file up a level):</p>
-<p><code>rm -rf generated; sphinx-apidoc -f -M -o  ./generated ../acapy_agent/ $(find ../acapy_agent/ -name '*tests*')</code></p>
+<p>To rebuild the project and settings from scratch:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nb">cd</span><span class="w"> </span>docs<span class="p">;</span><span class="w"> </span>rm<span class="w"> </span>-rf<span class="w"> </span>generated<span class="p">;</span><span class="w"> </span>sphinx-apidoc<span class="w"> </span>-f<span class="w"> </span>-M<span class="w"> </span>-o<span class="w">  </span>./generated<span class="w"> </span>../acapy_agent/<span class="w"> </span><span class="k">$(</span>find<span class="w"> </span>../acapy_agent/<span class="w"> </span>-name<span class="w"> </span><span class="s1">&#39;*tests*&#39;</span>,<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>..<span class="k">)</span>
+</code></pre></div>
 <p>Note that the <code>find</code> command that is used to exclude any of the <code>test</code> python files from the RTD documentation.</p>
-<p>Check the <code>git status</code> in your repo to see if the generator updates, adds or removes any existing RTD modules.</p>
+<p>Check the <code>git status</code> in your repo to see if the generator updates, adds or removes any existing RTD modules (in the <code>generated</code> folder).</p>
 <h3 id="reviewing-the-files-locally">Reviewing the files locally<a class="headerlink" href="#reviewing-the-files-locally" title="Permanent link">&para;</a></h3>
 <p>To auto-generate the module documentation locally run:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>sphinx-build<span class="w"> </span>-b<span class="w"> </span>html<span class="w"> </span>-a<span class="w"> </span>-E<span class="w"> </span>-c<span class="w"> </span>./<span class="w"> </span>./<span class="w"> </span>./_build
+<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nb">cd</span><span class="w"> </span>docs<span class="p">;</span><span class="w"> </span>sphinx-build<span class="w"> </span>-b<span class="w"> </span>html<span class="w"> </span>-a<span class="w"> </span>-E<span class="w"> </span>-c<span class="w"> </span>./<span class="w"> </span>./<span class="w"> </span>./_build<span class="p">;</span><span class="w"> </span><span class="nb">cd</span><span class="w"> </span>..
 </code></pre></div>
-<p>Once generated, go into the <code>_build</code> folder and open <code>index.html</code> in a browser. Note that the <code>_build</code> is
+<p>Once generated, go into the <code>docs/_build</code> folder and open <code>index.html</code> in a browser. Note that the <code>_build</code> is
 <code>.gitignore</code>'d and so will not be part of a git push.</p>
 <h3 id="look-for-errors">Look for Errors<a class="headerlink" href="#look-for-errors" title="Permanent link">&para;</a></h3>
 <p>This is the hard part; looking for errors in docstrings added by devs. Some tips:</p>

main/features/SupportedRFCs/index.html

@@ -72,7 +72,7 @@
     <div data-md-component="skip">
 
 
-        <a href="#aries-aip-and-rfcs-supported-in-aca-py" class="md-skip">
+        <a href="#aries-aip-protocols-credential-formats-and-aries-rfcs-supported-in-aca-py" class="md-skip">
           Skip to content
         </a>
 
@@ -2523,15 +2523,15 @@
 
 
 
-<h1 id="aries-aip-and-rfcs-supported-in-aca-py">Aries AIP and RFCs Supported in ACA-Py<a class="headerlink" href="#aries-aip-and-rfcs-supported-in-aca-py" title="Permanent link">&para;</a></h1>
+<h1 id="aries-aip-protocols-credential-formats-and-aries-rfcs-supported-in-aca-py">Aries AIP, Protocols, Credential Formats, and Aries RFCs Supported in ACA-Py<a class="headerlink" href="#aries-aip-protocols-credential-formats-and-aries-rfcs-supported-in-aca-py" title="Permanent link">&para;</a></h1>
 <p>This document provides a summary of the adherence of ACA-Py to the <a href="https://github.com/hyperledger/aries-rfcs/tree/main/concepts/0302-aries-interop-profile">Aries Interop
 Profiles</a>,
 and an overview of the ACA-Py feature set. This document is
 manually updated and as such, may not be up to date with the most recent release of
 ACA-Py or the repository <code>main</code> branch. Reminders (and PRs!) to update this page are
 welcome! If you have any questions, please contact us on the #aries channel on
 <a href="https://discord.gg/openwallet-foundation">OpenWallet Foundation Discord</a> or through an issue in this repo.</p>
-<p><strong>Last Update</strong>: 2024-10-08, Release 1.0.1</p>
+<p><strong>Last Update</strong>: 2024-10-15, Release 1.1.0</p>
 <blockquote>
 <p>The checklist version of this document was created as a joint effort
 between <a href="https://northernblock.io/">Northern Block</a>, <a href="https://animo.id/">Animo Solutions</a> and the Ontario government, on behalf of the Ontario government.</p>