From f0da14237789974ee5c5543231c2d40797e5f9b7 Mon Sep 17 00:00:00 2001 From: Harrison Date: Fri, 28 Apr 2023 14:10:15 -0500 Subject: [PATCH] Updated documentation publishing title and 'README.md' to link to CI --- Jenkinsfile | 2 +- README.md | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/Jenkinsfile b/Jenkinsfile index b2a9737..e6db3d1 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -24,7 +24,7 @@ pipeline { sh "python -m build" sh 'sphinx-apidoc -o docs/source/ src/bmlsa --force' 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") { diff --git a/README.md b/README.md index f4a0e4c..4c86ff0 100644 --- a/README.md +++ b/README.md @@ -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 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 - 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/)). \ No newline at end of file