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

Updates to readme, adding workflows #24

Merged
merged 3 commits into from
Nov 15, 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
28 changes: 28 additions & 0 deletions .github/workflows/mkdocs_deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: MkDocs Deploy

on:
push:
branches: [ main ]

jobs:
deploy:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.9' # Set your Python version here

- name: Install Poetry
run: |
curl -sSL https://install.python-poetry.org | python -

- name: Install dependencies
run: poetry install

- name: Deploy to GitHub Pages
run: poetry run mkdocs gh-deploy --force
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
28 changes: 28 additions & 0 deletions .github/workflows/mkdocs_pr_check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: MkDocs Build

on:
pull_request:
branches: [ main ]
push:
branches: [ main ]

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.9' # Set your Python version here

- name: Install Poetry
run: |
curl -sSL https://install.python-poetry.org | python -

- name: Install dependencies
run: poetry install

- name: Build MkDocs site
run: poetry run mkdocs build
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# GeneWaver Documentation

[![MkDocs Build](https://github.com/TheJacksonLaboratory/geneweaver-docs/actions/workflows/mkdocs_pr_check.yml/badge.svg?branch=main&event=push)](https://github.com/TheJacksonLaboratory/geneweaver-docs/actions/workflows/mkdocs_pr_check.yml)

This repository contains the central documentation site for the GeneWeaver project.
Geneweaver is a web-based software tool for the integration of functional genomics data.
The Geneweaver web application is available at [Geneweaver.org](https://geneweaver.org).
Expand All @@ -7,12 +10,12 @@ The documentation is built using [MkDocs](https://www.mkdocs.org/) and
[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/),
and is hosted on [GitHub Pages](https://pages.github.com/).

You can view the documentation at https://bergsalex.github.io/geneweaver-docs/.
You can view the documentation at https://thejacksonlaboratory.github.io/geneweaver-docs/.

## Getting Started
First, clone this repository to your local machine:
```bash
git clone git@github.com:bergsalex/geneweaver-docs.git
git clone git@github.com:TheJacksonLaboratory/geneweaver-docs.git
cd geneweaver-docs
```

Expand Down