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

Minor typo fix #128

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
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
49 changes: 49 additions & 0 deletions .github/workflows/build_pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Build pages using Doxygen
on:
workflow_dispatch:
inputs:
commitmsg:
description: 'Commit Message'
required: true
default: 'Update documentation'
# pull_request:
# branches:
# - master
# types:
# - closed
# paths:
# - 'docs/'

jobs:
build_pages:
# if: github.event.pull_request.merged == true
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Install Doxygen
run: |
cd ..
wget https://github.com/doxygen/doxygen/archive/refs/tags/Release_1_8_14.tar.gz
tar -xzf Release_1_8_14.tar.gz
cd doxygen-Release_1_8_14
mkdir build
cd build
cmake -G "Unix Makefiles" ..
make
sudo make install
cd ../../ivar
shell: bash

- name: Build pages
run: doxygen Doxyfile
shell: bash

- name: Commit to changes to branch
run: |
git config --global user.name '${{ github.actor }}'
git config --global user.email '${{ github.actor }}@users.noreply.github.com'
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
git commit -am "${{ github.event.inputs.commitmsg }}"
git push
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY = /Users/karthik/Documents/code/ivar/docs
OUTPUT_DIRECTORY = docs/

# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
Expand Down
2 changes: 1 addition & 1 deletion docs/MANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Usage: ivar filtervariants -p <prefix> replicate-one.tsv replicate-two.tsv ... O
Input: Variant tsv files for each replicate/sample

Input Options Description
-t Minimum fration of files required to contain the same variant. Specify value within [0,1]. (Default: 1)
-t Minimum fraction of files required to contain the same variant. Specify value within [0,1]. (Default: 1)
-f A text file with one variant file per line.

Output Options Description
Expand Down