Skip to content

Commit 3579fb5

Browse files
authored
Merge pull request #247 from ICRAR/fix_readme_and_docs
Fix README.rst and Doc failures
2 parents 0fa4e5c + 3cc1d73 commit 3579fb5

File tree

2 files changed

+40
-2
lines changed

2 files changed

+40
-2
lines changed

.readthedocs.yaml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version and other tools you might need
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.10"
12+
# You can also specify other tool versions:
13+
# nodejs: "20"
14+
# rust: "1.70"
15+
# golang: "1.20"
16+
17+
# Build documentation in the "docs/" directory with Sphinx
18+
sphinx:
19+
configuration: docs/conf.py
20+
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
21+
# builder: "dirhtml"
22+
# Fail on all warnings to avoid broken references
23+
# fail_on_warning: true
24+
25+
# Optionally build your docs in additional formats such as PDF and ePub
26+
# formats:
27+
# - pdf
28+
# - epub
29+
30+
# Optional but recommended, declare the Python requirements required
31+
# to build your documentation
32+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
33+
# python:
34+
# install:
35+
# - requirements: docs/requirements.txt

README.rst

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
Data Activated 流 Graph Engine
22
==============================
33

4-
.. image:: https://travis-ci.com/ICRAR/daliuge.svg?branch=master
5-
:target: https://travis-ci.com/github/ICRAR/daliuge
4+
.. image:: https://github.com/ICRAR/daliuge/actions/workflows/run-unit-tests.yml/badge.svg?branch=master
5+
:target: https://github.com/ICRAR/daliuge/actions/workflows/run-unit-tests.yml
66

77
.. image:: https://coveralls.io/repos/github/ICRAR/daliuge/badge.svg?branch=master
88
:target: https://coveralls.io/github/ICRAR/daliuge?branch=master
99

10+
.. image:: https://github.com/ICRAR/daliuge/actions/workflows/create-palettes.yml/badge.svg?branch=master
11+
:target: https://github.com/ICRAR/daliuge/actions/workflows/create-palettes.yml
12+
1013
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
1114
:target: https://github.com/psf/black
1215

0 commit comments

Comments
 (0)