Skip to content

Files

This branch is 21 commits behind openwallet-foundation/acapy:main.

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Feb 19, 2024
Oct 11, 2024
Oct 3, 2024
Jan 31, 2025
Feb 10, 2025
Jan 21, 2025
Oct 11, 2024
Jan 14, 2025
Jun 24, 2019
Oct 3, 2024
Jan 21, 2025
Oct 3, 2024
Oct 3, 2024
Oct 3, 2024
Jun 24, 2019
Mar 9, 2024
Jul 5, 2024
Feb 3, 2025

The ACA-Py docs Folder

The ACA-Py docs folder contains the source content for the ACA-Py documentation site aca-py.org and for the ACA-Py source code internals documentation project at ReadTheDocs, published at https://aries-cloud-agent-python.readthedocs.io.

This following covers how the two sets of documents are managed and how to update them.

To generate and locally run the docs website, use docker as follows:

  • Get a Material for Mkdocs docker image with the necessary extensions by running from the ACA_Py root folder:
    • docker build -f docs/mkdocs-dockerfile.yml -t squidfunk/mkdocs-material .
  • Run the resulting docker image from the root folder to generate the website on the current branch:
    • docker run --rm -it -p 8000:8000 --name mkdocs-material -v ${PWD}:/docs squidfunk/mkdocs-material
    • Open your browser: http://localhost:8000 and test out the docs.