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

Add support for GH-Pages #159

Merged
merged 16 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
4 changes: 4 additions & 0 deletions .github/workflows/ci-master.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,7 @@ jobs:

ssl_cert:
uses: ./.github/workflows/ssl_cert.yml

publish-docs:
name: Publish Documentation
uses: ./.github/workflows/gh-pages.yml
32 changes: 32 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Publish Documentation

on:
workflow_call:
workflow_dispatch:

jobs:

documentation-job:
runs-on: ubuntu-latest

steps:
- name: SCM Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/[email protected]

- name: Build Documentation
run: |
poetry run nox -s docs:multiversion

- name: Deploy
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: .html-documentation
git-config-name: Github Action
git-config-email: [email protected]

9 changes: 8 additions & 1 deletion doc/changes/unreleased.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Unreleased

## ✨Features

* Add support for multiversion documentation

## 🔩 Internal

* Add support for publishing documentation to gh pages

## 📚 Documentation

* Add sphinx based documention

118 changes: 0 additions & 118 deletions docs/BEST_PRACTICES.md

This file was deleted.

88 changes: 0 additions & 88 deletions docs/DBAPI_COMPAT.md

This file was deleted.

21 changes: 0 additions & 21 deletions docs/DEPENDENCIES.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/DESIGN.md

This file was deleted.

27 changes: 0 additions & 27 deletions docs/DEVELOPER_GUIDE.md

This file was deleted.

65 changes: 0 additions & 65 deletions docs/ENCRYPTION.md

This file was deleted.

Loading
Loading