Skip to content

Commit

Permalink
Update doc generation + add README badges (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
jhhb authored Jun 5, 2021
1 parent cb17404 commit e750a2f
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 6 deletions.
15 changes: 15 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# .readthedocs.yml
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

mkdocs:
configuration: mkdocs.yml
fail_on_warning: false

python:
version: 3.7
install:
- requirements: docs/requirements.txt

formats: all
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# 0.0.0 (YYYY-MM-DD)
# 0.0.0 (2021-06-04)

- TBD
- Initial release. All service providers documented on [docs.defipulse.com](https://web.archive.org/web/20210605215759/https://docs.defipulse.com/) are implemented.
File renamed without changes.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Overview
[![PyPI Version](https://img.shields.io/pypi/v/defipulsedata.svg)](https://pypi.org/project/defipulsedata)
[![PyPI License](https://img.shields.io/pypi/l/defipulsedata.svg)](https://pypi.org/project/defipulsedata)
[![Documentation](https://img.shields.io/readthedocs/defipulsedata.svg?logo=read-the-docs)](https://defipulsedata.readthedocs.io/en/latest/)

An unofficial Python SDK for the [DeFi Pulse Data](https://docs.defipulse.com/) project and
each of its partner service providers. This project provides a lightweight Python
Expand Down Expand Up @@ -76,7 +79,7 @@ pools.get_exchanges()

# Contributing and Filing Issues

Details for local development dependencies and useful Make targets can be found in `contributing.md`
Details for local development dependencies and useful Make targets can be found in [here](https://defipulsedata.readthedocs.io/en/latest/about/contributing/)

Contributions, suggestions, bug reports, are welcome and encouraged.

Expand Down
4 changes: 1 addition & 3 deletions README.todo.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,4 @@ This project was generated with [cookiecutter](https://github.com/audreyr/cookie
[![Unix Build Status](https://img.shields.io/travis/com/jhhb/pydefipulsedata.svg?label=unix)](https://travis-ci.com/jhhb/pydefipulsedata)
[![Windows Build Status](https://img.shields.io/appveyor/ci/jhhb/pydefipulsedata.svg?label=windows)](https://ci.appveyor.com/project/jhhb/pydefipulsedata)
[![Coverage Status](https://img.shields.io/coveralls/jhhb/pydefipulsedata.svg)](https://coveralls.io/r/jhhb/pydefipulsedata)
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/jhhb/pydefipulsedata.svg)](https://scrutinizer-ci.com/g/jhhb/pydefipulsedata)
[![PyPI Version](https://img.shields.io/pypi/v/defipulsedata.svg)](https://pypi.org/project/defipulsedata)
[![PyPI License](https://img.shields.io/pypi/l/defipulsedata.svg)](https://pypi.org/project/defipulsedata)
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/jhhb/pydefipulsedata.svg)](https://scrutinizer-ci.com/g/jhhb/pydefipulsedata)

0 comments on commit e750a2f

Please sign in to comment.