Skip to content

Commit

Permalink
add docs scripts (#136)
Browse files Browse the repository at this point in the history
  • Loading branch information
AzulGarza authored Oct 27, 2023
2 parents df99639 + a21e719 commit e89ad3c
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 0 deletions.
52 changes: 52 additions & 0 deletions .github/workflows/build-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: "build-docs"
on:
push:
branches: ["main"]
pull_request:
branches: ["main"]
workflow_dispatch:

defaults:
run:
shell: bash

jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
submodules: 'recursive'
- uses: actions/setup-python@v4
with:
cache: "pip"
python-version: '3.10'
cache-dependency-path: settings.ini
- name: Build docs
run: |
set -ux
python -m pip install --upgrade pip
pip install -Uq nbdev nbdev_plotly
pip install -e ".[dev]"
mkdir nbs/_extensions
cp -r docs-scripts/mintlify/ nbs/_extensions/
python docs-scripts/update-quarto.py
echo "procs = nbdev_plotly.plotly:PlotlyProc" >> settings.ini
nbdev_docs
- name: Apply final formats
run: bash ./docs-scripts/docs-final-formatting.bash
- name: Copy over necessary assets
run: |
cp nbs/mint.json _docs/mint.json
cp docs-scripts/imgs/* _docs/
- name: Deploy to Mintlify Docs
if: github.event_name == 'push'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: docs
publish_dir: ./_docs
# The following lines assign commit authorship to the official GH-Actions bot for deploys to `docs` branch.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[submodule "docs-scripts"]
path = docs-scripts
url = https://github.com/Nixtla/docs.git
branch = scripts
1 change: 1 addition & 0 deletions docs-scripts
Submodule docs-scripts added at d63d02

0 comments on commit e89ad3c

Please sign in to comment.