Skip to content

Commit d0892ac

Browse files
committedAug 5, 2024·
add test badge & RTD yaml config
1 parent ae547cd commit d0892ac

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed
 

‎.readthedocs.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.10"
12+
13+
# Build documentation in the docs/ directory with Sphinx
14+
sphinx:
15+
builder: html
16+
configuration: docs/source/conf.py
17+
fail_on_warning: false
18+
19+
# tell RTD to install the package with the docs optional requirements
20+
python:
21+
install:
22+
- method: pip
23+
path: .
24+
extra_requirements:
25+
- docs

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ Besides the data, this repository provides a Python library for loading, manipul
7878
> [!CAUTION]
7979
> This Python library is still highly experimental!
8080
81+
[![Tests](https://github.com/rmnldwg/lydata/actions/workflows/tests.yml/badge.svg)](https://github.com/rmnldwg/lydata/actions/workflows/tests.yml)
82+
8183
If you want to install this library, clone the repo and install it. You can do so by executing these commands:
8284

8385
```bash

0 commit comments

Comments
 (0)
Please sign in to comment.