From a9050e48e799a013d1dddfbf52fb3f5889b0cfb9 Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Sat, 9 Nov 2024 10:33:29 +0100 Subject: [PATCH 1/3] add badges and link to doc --- README.md | 9 +++++++++ docs/conf.py | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bc35465d3..b5ef6398b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +[![Deno build](https://github.com/bids-standard/bids-validator/actions/workflows/deno_tests.yml/badge.svg)](https://github.com/bids-standard/bids-validator/actions/workflows/deno_tests.yml) +[![Web validator](https://github.com/bids-standard/bids-validator/actions/workflows/web_build.yml/badge.svg)](https://github.com/bids-standard/bids-validator/actions/workflows/web_build.yml) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3688707.svg)](https://doi.org/10.5281/zenodo.3688707) + # The BIDS Validator The BIDS Validator is a web application, command-line utility, @@ -76,3 +80,8 @@ To modify the schema a clone of bids-standard/bids-specification will need to be After changes to the schema have been made to a local copy the dereferenced single json file used by the validator will need to be built. The `bidsschematools` python package does this. It can be installed from pypi via pip or a local installation can be made. It lives in the specification repository here https://github.com/bids-standard/bids-specification/tree/master/tools/schemacode The command to compile a dereferenced schema is `bst -v export --output src/schema.json` (this assumes you are in the root of the bids-specification repo). Once compiled it can be passed to the validator via the `-s` flag, `./bids-validator-deno -s ` + + +## Documentation + +The BIDS validator documentaion is available on [Read the Docs](https://bids-validator.readthedocs.io/en/latest/). \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 710b11c11..131f3b5cc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -7,7 +7,7 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = 'BIDS Validator' -copyright = '2024, BIDS Contributors' +copyright = 'BIDS Contributors' author = 'BIDS Contributors' # -- General configuration --------------------------------------------------- From adbcbf49c864aeb40f06669e1562c86c445aec32 Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Sat, 9 Nov 2024 11:19:38 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b5ef6398b..0484eb4cd 100644 --- a/README.md +++ b/README.md @@ -84,4 +84,4 @@ The command to compile a dereferenced schema is `bst -v export --output src/sche ## Documentation -The BIDS validator documentaion is available on [Read the Docs](https://bids-validator.readthedocs.io/en/latest/). \ No newline at end of file +The BIDS validator documentation is available on [Read the Docs](https://bids-validator.readthedocs.io/en/latest/). \ No newline at end of file From a877dca69725916071a25ee27cc109d7cba1d31a Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Sat, 9 Nov 2024 13:32:34 +0100 Subject: [PATCH 3/3] add badge doc --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0484eb4cd..8b53ea80f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ [![Deno build](https://github.com/bids-standard/bids-validator/actions/workflows/deno_tests.yml/badge.svg)](https://github.com/bids-standard/bids-validator/actions/workflows/deno_tests.yml) [![Web validator](https://github.com/bids-standard/bids-validator/actions/workflows/web_build.yml/badge.svg)](https://github.com/bids-standard/bids-validator/actions/workflows/web_build.yml) +[![Documentation Status](https://readthedocs.org/projects/bids-validator/badge/?version=latest)](https://bids-validator.readthedocs.io/en/latest/?badge=latest) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3688707.svg)](https://doi.org/10.5281/zenodo.3688707) # The BIDS Validator