Skip to content

Commit

Permalink
feat(bindings/python): build docs on CI
Browse files Browse the repository at this point in the history
  • Loading branch information
messense committed Mar 18, 2023
1 parent 5a4491f commit d6c987a
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,27 @@ jobs:
- name: Copy docs into build
run: |
cp -r ./bindings/nodejs/docs ./website/static/docs/nodejs
# Setup python environment ----------------------------------------
- uses: actions/setup-python@v4
with:
python-version: '3.11'

# Build bindings/python docs --------------------------------------
- name: Install dependencies
working-directory: bindings/python
run: |
set -e
python -m pip install -e .
python -m pip install pdoc
- name: Build bindings/python Docs
working-directory: bindings/python
run: pdoc --output-dir ./docs opendal

- name: Copy docs into build
run: |
cp -r ./bindings/python/docs ./website/static/docs/python
# Build website ---------------------------------------------------
- name: Install Dependencies
Expand Down
4 changes: 4 additions & 0 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,10 @@ const config = {
type: 'html',
value: '<a class="dropdown__link" href="/docs/nodejs/">Node.js</a>'
},
{
type: 'html',
value: '<a class="dropdown__link" href="/docs/python/">Python</a>'
},
]
},
{
Expand Down

0 comments on commit d6c987a

Please sign in to comment.