Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: object store configuration #1849

Merged
merged 5 commits into from
Jan 24, 2024
Merged
Changes from 1 commit
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
Prev Previous commit
Next Next commit
fix action
wjones127 committed Jan 18, 2024
commit 2057ddca7d8054b359c112749836c9f62749221a
50 changes: 50 additions & 0 deletions .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Check docs

on:
push:
branches: ["main"]
pull_request:
paths:
- docs/**

env:
# Disable full debug symbol generation to speed up CI build and keep memory down
# "1" means line tables only, which is useful for panic tracebacks.
RUSTFLAGS: "-C debuginfo=1"
# according to: https://matklad.github.io/2021/09/04/fast-rust-builds.html
# CI builds are faster with incremental disabled.
CARGO_INCREMENTAL: "0"

jobs:
# Single deploy job since we're just deploying
check-docs:
runs-on: ubuntu-22.04-4core
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
cache: 'pip'
cache-dependency-path: "docs/requirements.txt"
- name: Install dependencies
run: |
sudo apt install -y -qq doxygen pandoc
- name: Build python wheel
uses: ./.github/workflows/build_linux_wheel
- name: Build Python
working-directory: python
run: |
python -m pip install $(ls target/wheels/*.whl)
python -m pip install -r ../docs/requirements.txt
- name: Build docs
working-directory: docs
run: |
make nbconvert
make html
- name: Check links
working-directory: docs
run: |
make linkcheck

13 changes: 1 addition & 12 deletions .github/workflows/docs.yml → .github/workflows/docs-deploy.yml
Original file line number Diff line number Diff line change
@@ -3,9 +3,6 @@ name: Deploy docs to Pages
on:
push:
branches: ["main"]
pull_request:
paths:
- docs/**

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
@@ -60,20 +57,12 @@ jobs:
run: |
make nbconvert
make html
- name: Check links
working-directory: docs
run: |
make linkcheck
- name: Setup Pages
uses: actions/configure-pages@v2
if: github.ref == 'refs/heads/main'
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: 'docs/_build/html'
if: github.ref == 'refs/heads/main'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
if: github.ref == 'refs/heads/main'

uses: actions/deploy-pages@v1