Skip to content

Commit

Permalink
ci: Add workflow for doc publishing (#80)
Browse files Browse the repository at this point in the history
* ci: Add workflow for doc publishing

* ci: Fix doc workflow
  • Loading branch information
Ramimashkouk authored Aug 30, 2024
1 parent 76e5919 commit 4305070
Show file tree
Hide file tree
Showing 3 changed files with 137 additions and 47 deletions.
43 changes: 43 additions & 0 deletions .github/workflows/build_and_publish_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: build_and_publish_docs

on:
workflow_dispatch:

permissions:
contents: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
publish:
name: build and publish docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: set up python 3.9
uses: actions/setup-python@v5
with:
python-version: 3.9

- name: setup poetry
run: |
python -m pip install --upgrade pip poetry
- name: install dependencies
run: poetry install

- name: build documentation
run: poetry run make -C docs html

- name: remove jekyll theming
run: touch docs/_build/html/.nojekyll

- name: deploy website
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: docs/_build/html
single-commit: True
137 changes: 92 additions & 45 deletions backend/poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions backend/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ pytest-mock = "^3.14.0"
httpx = "^0.27.0"
httpx-ws = "^0.6.0"
pylint = "^3.2.3"
sphinx = { version = "*", python = "^3.10"}
sphinx-rtd-theme = { version = "*", python = "^3.10"}
sphinx = "*"
sphinx-rtd-theme = "*"

[tool.poetry.scripts]
"chatsky.ui" = "chatsky_ui.cli:cli"
Expand Down

0 comments on commit 4305070

Please sign in to comment.