axondeepseg / axondeepseg / 12320067716
79%

DEFAULT BRANCH: master
Ran
Jobs 1
Files 17
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 93.728%. Remained the same
12320067716

push

github

web-flow 
Set `fail_on_warning = True` and resolve documentation warnings to ensure docs pass (#846)

* `.readthedocs.yml`: Set `fail_on_warning` to true

* `conf.py`: Remove duplicated `html_theme_options` dict

The second dict was overwriting the first one, meaning that the keys
were being completely ignored.

Also, when I tried re-adding those same keys, I got many errors:

```
WARNING: unsupported theme option 'github_user' given
WARNING: unsupported theme option 'github_repo' given
WARNING: unsupported theme option 'github_button' given
WARNING: unsupported theme option 'github_banner' given
```

* `conf.py`: Update incorrect theme option key name

See: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#theme-options

* `conf.py`: Replace `language = None` with `'en'`

Addresses the following warning:

> WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English).

* `index.rst`: Remove unnecessary `:scale:` option

This image option is being ignored entirely by Sphinx right now, and
the figures look good as-is. :)

* `index.rst`: Replace placeholder alt-text with real alt-text

For all the visually impaired folk out there. :)

* `documentation.rst`: Use anonymous hyperlinks

This is something that SCT also wants to adopt. See:
https://github.com/spinalcordtoolbox/spinalcordtoolbox/issues/4371

* `environment.yml`: Switch to `conda-forge` for RTD build

* Replace RTD conda install with pip/PyPI install

---------

Co-authored-by: Mathieu Boudreau, PhD <emb6150@gmail.com>

1046 of 1116 relevant lines covered (93.73%)

2.81 hits per line

Jobs
ID Job ID Ran Files Coverage
1 ${matrix.os} - 12320067716.1 0
93.73
 GitHub Action Run
Source Files on build 12320067716
Detailed source file information is not available for this build.