Skip to content

Commit 4255e32

Browse files
committed
try building mkdocs with github action
1 parent c906cc8 commit 4255e32

File tree

3 files changed

+28
-3
lines changed

3 files changed

+28
-3
lines changed

.github/workflows/mkdocs.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: docs
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
jobs:
8+
build:
9+
name: Deploy docs
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout main
13+
uses: actions/checkout@v2
14+
15+
- name: Deploy docs
16+
uses: quinlan-lab/proj-mutator-mapping@master
17+
# Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
18+
env:
19+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
20+
#CUSTOM_DOMAIN: optionaldomain.com
21+
CONFIG_FILE: folder/mkdocs.yml
22+
#EXTRA_PACKAGES: build-base
23+
# GITHUB_DOMAIN: github.myenterprise.com
24+
REQUIREMENTS: folder/requirements.txt

.github/workflows/starter.yaml renamed to .github/workflows/tests.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Tests
1+
name: tests
22

33
on: [push]
44

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Mapping mutator alleles with inter-haplotype distance
22

3-
[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://quinlan-lab.github.io/proj-mutator-mapping/reference/)
4-
![pytest](https://github.com/quinlan-lab/proj-mutator-mapping/actions/workflows/starter.yaml/badge.svg)
3+
[![docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://quinlan-lab.github.io/proj-mutator-mapping/reference/)
4+
![docs](https://github.com/quinlan-lab/proj-mutator-mapping/actions/workflows/mkdocs.yaml/badge.svg)
5+
![pytest](https://github.com/quinlan-lab/proj-mutator-mapping/actions/workflows/tests.yaml/badge.svg)
56
## Summary
67

78
Identify alleles that affect the mutation spectrum in bi-parental recombinant inbred crosses.

0 commit comments

Comments
 (0)