Skip to content

Commit

Permalink
Merge pull request #247 from ICRAR/fix_readme_and_docs
Browse files Browse the repository at this point in the history
Fix README.rst and Doc failures
  • Loading branch information
awicenec committed May 13, 2024
2 parents 0fa4e5c + 3cc1d73 commit 3579fb5
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 2 deletions.
35 changes: 35 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.10"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true

# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt
7 changes: 5 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
Data Activated 流 Graph Engine
==============================

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

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

.. image:: https://github.com/ICRAR/daliuge/actions/workflows/create-palettes.yml/badge.svg?branch=master
:target: https://github.com/ICRAR/daliuge/actions/workflows/create-palettes.yml

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black

Expand Down

0 comments on commit 3579fb5

Please sign in to comment.