Skip to content

Commit

Permalink
Add first draft of upload workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
Dr-Electron committed Oct 9, 2023
1 parent f54a375 commit b626270
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 1 deletion.
25 changes: 25 additions & 0 deletions .github/workflows/upload-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Build and upload API docs

on:
push:
branches: [develop, staging]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Build python docs
run: |
cd bindings/python
pip install -r requirements-dev.txt
PYTHONPATH=. pydoc-markdown
cd -
- name: Build nodejs docs
run: |
cd bindings/nodejs
# The SDK still uses yarn classic: https://github.com/iotaledger/iota-sdk/issues/433
yarn set version classic
yarn
yarn create-api-docs --out ../../docs/references/nodejs
cd -
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,6 @@ address.json
.DS_Store
book
.venv*

# Temporary documentation
/docs
2 changes: 1 addition & 1 deletion bindings/python/pydoc-markdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ processors:
- type: crossref
renderer:
type: docusaurus
docs_base_path: ./docs/
docs_base_path: ../../docs/
relative_output_path: references/python

markdown:
Expand Down

0 comments on commit b626270

Please sign in to comment.