Skip to content

Commit

Permalink
Merge pull request #78 from vanna-ai/update-docs-3
Browse files Browse the repository at this point in the history
New documentation format
  • Loading branch information
zainhoda authored Aug 2, 2023
2 parents ea36329 + eb62b2a commit d75cd99
Show file tree
Hide file tree
Showing 32 changed files with 1,577 additions and 1,701 deletions.
16 changes: 10 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ name: ci
on:
push:
branches:
- master
- main
- update-docs-3
permissions:
contents: write
jobs:
Expand All @@ -17,11 +17,15 @@ jobs:
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ env.cache_id }}
key: vanna-docs-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: pip install mkdocstrings[python]
vanna-docs-
- run: pip install PyYAML
- run: pip install nbconvert
- run: pip install ghp-import
- run: pip install pdoc
- run: pip install .
- run: mkdocs gh-deploy --force
- run: pdoc vanna --logo https://img.vanna.ai/vanna-ref.svg --logo-link https://docs.vanna.ai --no-show-source --mermaid --docformat google -n -o docs
- run: python docs/sidebar.py docs/sidebar.yaml notebooks docs
- run: ghp-import -n -p -f docs
3 changes: 1 addition & 2 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: Python tests
name: Integration Test using Debug Server

on:
push: {}
pull_request: {}

permissions:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ notebooks/.ipynb_checkpoints
tests/__pycache__
__pycache__/
.idea
docs/*.html
Binary file removed docs/chart.png
Binary file not shown.
7 changes: 0 additions & 7 deletions docs/index.html

This file was deleted.

Binary file removed docs/notebooks/plot1.png
Binary file not shown.
Binary file removed docs/notebooks/plot2.png
Binary file not shown.
Binary file removed docs/notebooks/plot3.png
Binary file not shown.
Loading

0 comments on commit d75cd99

Please sign in to comment.