Updated documentation publishing title and 'README.md' to link to CI
All checks were successful
ydeng/bmlsa/pipeline/head This commit looks good

This commit is contained in:
Harrison Deng 2023-04-28 14:10:15 -05:00
parent 4383e36c1f
commit f0da142377
2 changed files with 6 additions and 1 deletions

2
Jenkinsfile vendored
View File

@ -24,7 +24,7 @@ pipeline {
sh "python -m build" sh "python -m build"
sh 'sphinx-apidoc -o docs/source/ src/bmlsa --force' sh 'sphinx-apidoc -o docs/source/ src/bmlsa --force'
sh 'make -C docs html' sh 'make -C docs html'
publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: false, reportDir: 'docs/build/html', reportFiles: 'index.html', reportName: 'BMLSA', reportTitles: '']) publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: false, reportDir: 'docs/build/html', reportFiles: 'index.html', reportName: 'Documentation', reportTitles: ''])
} }
} }
stage("test installation") { stage("test installation") {

View File

@ -1,3 +1,5 @@
[![Build Status](https://ci.reslate.systems/job/ydeng/job/bmlsa/job/master/badge/icon)](https://ci.reslate.systems/job/ydeng/job/bmlsa/job/master/)
# BMLSA # BMLSA
A Basic multi local sequence alignment tool using the Biopython implementation of the Smith-Waterman alignment algorithm. A Basic multi local sequence alignment tool using the Biopython implementation of the Smith-Waterman alignment algorithm.
@ -11,3 +13,6 @@ A Basic multi local sequence alignment tool using the Biopython implementation o
- Automatically align with all sequences in reference FASTA - Automatically align with all sequences in reference FASTA
- All produced output is human readable! - All produced output is human readable!
## More Information
For all live downloadable artifacts, build statuses, unit test results, and documentation, check out the continuous integration page for the [master branch](https://ci.reslate.systems/job/ydeng/job/bmlsa/job/master/) ([development branch](https://ci.reslate.systems/job/ydeng/job/bmlsa/job/develop/)).