Skip to content

Commit

Permalink
Deployed 9997135 to main with MkDocs 1.6.1 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Feb 14, 2025
1 parent c87ae16 commit aa126f9
Show file tree
Hide file tree
Showing 13 changed files with 19 additions and 185 deletions.
8 changes: 5 additions & 3 deletions main/UpdateRTD/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2560,16 +2560,18 @@ <h2 id="generating-aca-py-read-the-docs-rtd-documentation">Generating ACA-Py Rea
<h3 id="before-you-start">Before you start<a class="headerlink" href="#before-you-start" title="Permanent link">&para;</a></h3>
<p>To test generate and view the RTD documentation locally, you must install <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> and the
<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>
and verify the installation on your system. Alternatively, use pip to install it:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>docs/requirements.txt<span class="w"> </span>--upgrade
</code></pre></div>
<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:</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="k">)</span><span class="p">;</span><span class="w"> </span><span class="nb">cd</span><span class="w"> </span>..
<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>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="k">)</span><span class="p">;</span><span class="w"> </span><span class="nb">cd</span><span class="w"> </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 (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-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>..
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-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>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>
Expand Down
3 changes: 0 additions & 3 deletions main/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -254,9 +254,6 @@

# -- Extension configuration -------------------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"https://docs.python.org/": None}


# To supress cross-reference warnings
# https://github.com/sphinx-doc/sphinx/issues/3866#issuecomment-768167824
Expand Down
8 changes: 8 additions & 0 deletions main/generated/acapy_agent.connections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,11 @@ acapy\_agent.connections.base\_manager module
:members:
:undoc-members:
:show-inheritance:

acapy\_agent.connections.routes module
--------------------------------------

.. automodule:: acapy_agent.connections.routes
:members:
:undoc-members:
:show-inheritance:
26 changes: 0 additions & 26 deletions main/generated/acapy_agent.protocols.connections.rst

This file was deleted.

42 changes: 0 additions & 42 deletions main/generated/acapy_agent.protocols.connections.v1_0.handlers.rst

This file was deleted.

42 changes: 0 additions & 42 deletions main/generated/acapy_agent.protocols.connections.v1_0.messages.rst

This file was deleted.

18 changes: 0 additions & 18 deletions main/generated/acapy_agent.protocols.connections.v1_0.models.rst

This file was deleted.

44 changes: 0 additions & 44 deletions main/generated/acapy_agent.protocols.connections.v1_0.rst

This file was deleted.

1 change: 0 additions & 1 deletion main/generated/acapy_agent.protocols.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Subpackages

acapy_agent.protocols.actionmenu
acapy_agent.protocols.basicmessage
acapy_agent.protocols.connections
acapy_agent.protocols.coordinate_mediation
acapy_agent.protocols.did_rotate
acapy_agent.protocols.didexchange
Expand Down
2 changes: 1 addition & 1 deletion main/readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
version: 2

build:
os: "ubuntu-20.04"
os: "ubuntu-24.04"
tools:
python: "3.12"

Expand Down
8 changes: 4 additions & 4 deletions main/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Defining the exact versions for ReadTheDocs that will make sure things don't break
sphinx==5.3.0
sphinx_rtd_theme==1.3.0
readthedocs-sphinx-search==0.3.2
sphinx-notfound-page==1.1.0
sphinx~=8.1.3
sphinx-rtd-theme~=3.0.2
readthedocs-sphinx-search~=0.3.2
sphinx-notfound-page~=1.1.0
2 changes: 1 addition & 1 deletion main/search/search_index.json

Large diffs are not rendered by default.

Binary file modified main/sitemap.xml.gz
Binary file not shown.

0 comments on commit aa126f9

Please sign in to comment.