Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Build Documentation

on:
workflow_dispatch:
release:
types: [published]

jobs:
docs:
permissions:
contents: write
uses: algorandfoundation/workflows/.github/workflows/algokit-build-docs.yml@main
with:
docs_branch: docs-dist
2 changes: 1 addition & 1 deletion .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
shell: bash
run: |
npm ci --ignore-scripts
npm run generate:code-docs
npm run algo-docs:build
# Add untracked files as empty so they come up in diff
git add -N .
# Print changed files and error out if there are changes after generating docs
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ jobs:
- name: Install dependencies to get semantic release components and plugins
run: npm ci --ignore-scripts

- name: 'Semantic release'
- name: "Semantic release"
run: npx semantic-release
env:
# Use the GitHub App token for authentication
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,5 @@ __pycache__

*.db
*.db-journal
docs/manifest.json
docs-publish/
12 changes: 12 additions & 0 deletions docs-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"$schema": "https://unpkg.com/@algorandfoundation/algo-docs-sync/schema/v1.json",
"version": "1.0",
"generator": "typedoc",
"basePath": "docs",
"guides": {
"include": "**/*.md"
},
"api": {
"include": "**/*.md"
}
}
20 changes: 20 additions & 0 deletions docs/api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Overview
sidebar:
order: 0
---

**@algorandfoundation/algokit-subscriber**

***

# @algorandfoundation/algokit-subscriber

## Modules

- [index](index/README.md)
- [types](types/README.md)
- [types/arc-28](types/arc-28/README.md)
- [types/async-event-emitter](types/async-event-emitter/README.md)
- [types/block](types/block/README.md)
- [types/subscription](types/subscription/README.md)
19 changes: 19 additions & 0 deletions docs/api/index/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Overview
sidebar:
order: 0
---

[**@algorandfoundation/algokit-subscriber**](../README.md)

***

# index

## Classes

- [AlgorandSubscriber](classes/AlgorandSubscriber.md)

## Functions

- [getSubscribedTransactions](functions/getSubscribedTransactions.md)
Loading
Loading