Skip to content

Commit

Permalink
Add stable docs build (#344)
Browse files Browse the repository at this point in the history
Co-authored-by: Arnau Casau <[email protected]>
Co-authored-by: Eric Arellano <[email protected]>
  • Loading branch information
3 people committed Mar 18, 2024
1 parent cdde975 commit dcd387a
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ jobs:
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs/_build/html/
clean-exclude: |
stable/*
38 changes: 38 additions & 0 deletions .github/workflows/docs_stable.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Stable Docs Publish
on:
workflow_dispatch:
push:
tags:
- "*"

jobs:
deploy:
if: github.repository_owner == 'Qiskit-Extensions'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -U virtualenv setuptools wheel tox
sudo apt-get install graphviz pandoc
- name: Build docs stable
env:
QISKIT_DOCS_BUILD_TUTORIALS: 'always'
run: tox -e docs
- name: Bypass Jekyll Processing # Necessary for setting the correct css path
run: touch docs/_build/html/.nojekyll
- name: Set current version
run: |
echo "version=$(git describe --abbrev=0 | cut -d'.' -f1,2)" >> "$GITHUB_ENV"
- name: Deploy stable
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs/_build/html
target-folder: stable/${{ env.version }}
4 changes: 3 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@
html_theme = 'qiskit-ecosystem'
html_last_updated_fmt = '%Y/%m/%d'

html_context = {"analytics_enabled": True}
docs_url_prefix = "qiskit-dynamics"

html_context = {"version_list": ["0.4"]}

# autodoc/autosummary options
autosummary_generate = True
Expand Down

0 comments on commit dcd387a

Please sign in to comment.