Skip to content

Commit

Permalink
documentation polishing
Browse files Browse the repository at this point in the history
  • Loading branch information
yzhao062 committed Oct 27, 2021
1 parent f7eb9be commit dc3fb25
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 63 deletions.
33 changes: 1 addition & 32 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Python Outlier Detection (PyOD)
===============================

**Deployment & Documentation & Stats**
**Deployment & Documentation & Stats & License**

.. image:: https://img.shields.io/pypi/v/pyod.svg?color=brightgreen
:target: https://pypi.org/project/pyod/
Expand All @@ -18,11 +18,6 @@ Python Outlier Detection (PyOD)
:alt: Documentation status


.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/yzhao062/pyod/master
:alt: Binder


.. image:: https://img.shields.io/github/stars/yzhao062/pyod.svg
:target: https://github.com/yzhao062/pyod/stargazers
:alt: GitHub stars
Expand All @@ -37,37 +32,11 @@ Python Outlier Detection (PyOD)
:target: https://pepy.tech/project/pyod
:alt: Downloads


.. image:: https://pepy.tech/badge/pyod/month
:target: https://pepy.tech/project/pyod
:alt: Downloads


.. image:: https://img.shields.io/badge/slack-join-green
:target: https://join.slack.com/t/pyod/shared_invite/zt-vprc4w2q-G2XV2Iou~H84yGSvrh0f6A
:alt: slack


-----

**Build Status & Coverage & Maintainability & License**


.. image:: https://ci.appveyor.com/api/projects/status/1kupdy87etks5n3r/branch/master?svg=true
:target: https://ci.appveyor.com/project/yzhao062/pyod/branch/master
:alt: Build status


.. image:: https://github.com/yzhao062/pyod/actions/workflows/testing.yml/badge.svg
:target: https://github.com/yzhao062/pyod/actions/workflows/testing.yml
:alt: testing


.. image:: https://circleci.com/gh/yzhao062/pyod.svg?style=svg
:target: https://circleci.com/gh/yzhao062/pyod
:alt: Circle CI


.. image:: https://coveralls.io/repos/github/yzhao062/pyod/badge.svg
:target: https://coveralls.io/github/yzhao062/pyod
:alt: Coverage Status
Expand Down
34 changes: 3 additions & 31 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
Welcome to PyOD documentation!
==============================

**Deployment & Documentation & Stats**

**Deployment & Documentation & Stats & License**

.. image:: https://img.shields.io/pypi/v/pyod.svg?color=brightgreen
:target: https://pypi.org/project/pyod/
Expand All @@ -23,11 +24,6 @@ Welcome to PyOD documentation!
:alt: Documentation status


.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/yzhao062/pyod/master
:alt: Binder


.. image:: https://img.shields.io/github/stars/yzhao062/pyod.svg
:target: https://github.com/yzhao062/pyod/stargazers
:alt: GitHub stars
Expand All @@ -42,36 +38,11 @@ Welcome to PyOD documentation!
:target: https://pepy.tech/project/pyod
:alt: Downloads


.. image:: https://pepy.tech/badge/pyod/month
:target: https://pepy.tech/project/pyod
:alt: Downloads


.. image:: https://img.shields.io/badge/slack-join-green
:target: https://join.slack.com/t/pyod/shared_invite/zt-vprc4w2q-G2XV2Iou~H84yGSvrh0f6A
:alt: slack

-----

**Build Status & Coverage & Maintainability & License**


.. image:: https://ci.appveyor.com/api/projects/status/1kupdy87etks5n3r/branch/master?svg=true
:target: https://ci.appveyor.com/project/yzhao062/pyod/branch/master
:alt: Build status


.. image:: https://github.com/yzhao062/pyod/actions/workflows/testing.yml/badge.svg
:target: https://github.com/yzhao062/pyod/actions/workflows/testing.yml
:alt: testing


.. image:: https://circleci.com/gh/yzhao062/pyod.svg?style=svg
:target: https://circleci.com/gh/yzhao062/pyod
:alt: Circle CI


.. image:: https://coveralls.io/repos/github/yzhao062/pyod/badge.svg
:target: https://coveralls.io/github/yzhao062/pyod
:alt: Coverage Status
Expand All @@ -87,6 +58,7 @@ Welcome to PyOD documentation!
:alt: License



----

PyOD is a comprehensive and scalable **Python toolkit** for **detecting outlying objects** in
Expand Down
24 changes: 24 additions & 0 deletions temp_text.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,27 @@ be found at `Moving to require Python 3 <https://python3statement.org/>`_.
Running examples needs **matplotlib**, which may throw errors in conda
virtual environment on mac OS. See reasons and solutions `mac_matplotlib <https://github.com/yzhao062/pyod/issues/6>`_.


.. image:: https://ci.appveyor.com/api/projects/status/1kupdy87etks5n3r/branch/master?svg=true
:target: https://ci.appveyor.com/project/yzhao062/pyod/branch/master
:alt: Build status

.. image:: https://circleci.com/gh/yzhao062/pyod.svg?style=svg
:target: https://circleci.com/gh/yzhao062/pyod
:alt: Circle CI

.. image:: https://img.shields.io/badge/slack-join-green
:target: https://join.slack.com/t/pyod/shared_invite/zt-vprc4w2q-G2XV2Iou~H84yGSvrh0f6A
:alt: slack

.. image:: https://pepy.tech/badge/pyod/month
:target: https://pepy.tech/project/pyod
:alt: Downloads

.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/yzhao062/pyod/master
:alt: Binder

-----

**Build Status & Coverage & Maintainability & License**

0 comments on commit dc3fb25

Please sign in to comment.