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

Online docs #711

Merged
merged 2 commits into from
Sep 20, 2023
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
40 changes: 40 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Test Pipeline

on:
push:
branches:
- '*'
- '!gh-pages' # excludes master

jobs:
build:
runs-on: ubuntu-latest

steps:
# Checkout the latest code
- name: Checkout Code
uses: actions/checkout@v2

# Setup Python environment
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: '3.x'

# Install dependencies for your project
- name: Install Dependencies
run: |
pip install -e .[test]
pip install sphinx

# Run tests
- name: Run Tests
run: |
cd tests
pytest test_tree.py

# Build Sphinx documentation
- name: Generate Sphinx Documentation
run: |
cd doc
make html
39 changes: 39 additions & 0 deletions .github/workflows/update_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Update github pages docs

on:
push:
branches:
- online_docs

jobs:
build:
runs-on: ubuntu-latest

steps:
# Checkout the latest code
- name: Checkout Code
uses: actions/checkout@v2

# Setup Python environment
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: '3.x'

# Install dependencies for your project
- name: Install Dependencies
run: |
pip install .
pip install sphinx

# Build Sphinx documentation
- name: Generate Sphinx Documentation
run: |
cd doc
make html

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./doc/_build/html/
Loading