diff --git a/README.md b/README.md index 535d249..7ac17cd 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ ![OSSAR](https://github.com/TheodoreHua/ClaimDoneRemover/workflows/OSSAR/badge.svg) [![Actively Developed](https://img.shields.io/badge/Maintenance%20Level-Actively%20Developed-brightgreen.svg)](https://github.com/TheodoreHua/MaintenanceLevels#actively-developed) ![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability-percentage/TheodoreHua/ClaimDoneRemover) +[![Documentation Status](https://readthedocs.org/projects/claimdoneremover/badge/?version=stable)](https://claimdoneremover.theodorehua.dev/en/stable/?badge=stable) [![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/theodorehuadev@gmail.com) [![GitHub issues](https://img.shields.io/github/issues/TheodoreHua/ClaimDoneRemover)](https://github.com/TheodoreHua/ClaimDoneRemover/issues) ![GitHub pull requests](https://img.shields.io/github/issues-pr/TheodoreHua/ClaimDoneRemover) @@ -12,6 +13,13 @@ ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/TheodoreHua/ClaimDoneRemover/latest/dev) ![GitHub repo size](https://img.shields.io/github/repo-size/TheodoreHua/ClaimDoneRemover) +--- + +Documentation for this project has been moved to [Read the Docs](https://claimdoneremover.theodorehua.dev) due to the +documentation growing increasingly long and not suitable for a single README. + +--- + **This is an unofficial program and is not officially endorsed by the Transcribers of Reddit; they are in no way involved with this program and are not liable for any matters relating to it.** diff --git a/docs/source/about.rst b/docs/source/about.rst index 6628161..868f8e1 100644 --- a/docs/source/about.rst +++ b/docs/source/about.rst @@ -6,6 +6,8 @@ About this happens only in rare cases however notice that it *can* happen. Although `ToR User Stats `__ is better than the discord bot anyways. +**This is an unofficial program and is not officially endorsed by the Transcribers of Reddit** + Claim Done Remover, shortened to CDR, is a program designed for `r/TranscribersOfReddit `__ users to allow them to automatically delete `claim`, `done` (and anything else) comments after a certain `trigger `_ happens. diff --git a/docs/source/conf.py b/docs/source/conf.py index 0ba74da..361e4bc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -48,4 +48,4 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file +html_static_path = ['_static']