docs: add pypi badge (#241)

LizardByte · Jul 24, 2024 · 0adc03d · 0adc03d
1 parent d434893
commit 0adc03d
Show file tree

Hide file tree

Showing 11 changed files with 34 additions and 31 deletions.
diff --git a/README.rst b/README.rst
@@ -1,25 +1,5 @@
-:github_url: https://github.com/LizardByte/plexhints/tree/nightly/README.rst
-
-Overview
-========
-LizardByte has the full documentation hosted on `Read the Docs <http://plexhints.readthedocs.io/>`__.
-
-About
------
-Plexhints is a set of tools to aid in the development of plugins for Plex Media Server. It is not a framework, but
-rather a set of tools that can be used to make your life easier.
-
-Features
---------
-- Python library providing type hints to aid in the development of Plex plugins. Get rid of all those IDE warnings
-  and errors!
-- A GitHub Action that will install and bootstrap a Plex Media Server in a CI environment. The action can install
-  plugins and setup dummy libraries. Additionally the Plex token is provided as an output. This is useful for testing
-  your plugin or other Plex project in a CI environment.
-
-Integrations
-------------
-
+plexhints
+=========
 .. image:: https://img.shields.io/github/actions/workflow/status/lizardbyte/plexhints/CI.yml.svg?branch=master&label=CI%20build&logo=github&style=for-the-badge
    :alt: GitHub Workflow Status (CI)
    :target: https://github.com/LizardByte/plexhints/actions/workflows/CI.yml?query=branch%3Amaster
@@ -39,3 +19,24 @@ Integrations
 .. image:: https://img.shields.io/pypi/v/plexhints.svg?style=for-the-badge&logo=pypi&label=pypi%20package
    :alt: PyPI
    :target: https://pypi.org/project/plexhints/
+
+.. image:: https://img.shields.io/pypi/dm/plexhints?style=for-the-badge&logo=pypi&label=pypi%20downloads
+   :alt: PyPI - Downloads
+   :target: https://pypi.org/project/plexhints/
+
+Overview
+--------
+Plexhints is a set of tools to aid in the development of plugins for Plex Media Server. It is not a framework, but
+rather a set of tools that can be used to make your life easier.
+
+Documentation is available on `Read the Docs <http://plexhints.readthedocs.io/>`__.
+
+This project is not affiliated with Plex Inc.
+
+Features
+--------
+- Python library providing type hints to aid in the development of Plex plugins. Get rid of all those IDE warnings
+  and errors!
+- A GitHub Action that will install and bootstrap a Plex Media Server in a CI environment. The action can install
+  plugins and setup dummy libraries. Additionally the Plex token is provided as an output. This is useful for testing
+  your plugin or other Plex project in a CI environment.
diff --git a/docs/source/about/github_action.rst b/docs/source/about/github_action.rst
@@ -1,4 +1,4 @@
-:github_url: https://github.com/LizardByte/plexhints/tree/nightly/docs/source/about/github_action.rst
+:github_url: https://github.com/LizardByte/plexhints/blob/master/docs/source/about/github_action.rst
 
 GitHub Action
 =============

diff --git a/docs/source/about/installation.rst b/docs/source/about/installation.rst
@@ -1,4 +1,4 @@
-:github_url: https://github.com/LizardByte/plexhints/tree/nightly/docs/source/about/installation.rst
+:github_url: https://github.com/LizardByte/plexhints/blob/master/docs/source/about/installation.rst
 
 Installation
 ============

diff --git a/docs/source/about/overview.rst b/docs/source/about/overview.rst
@@ -1 +1,3 @@
+:github_url: https://github.com/LizardByte/plexhints/blob/master/README.rst
+
 .. include:: ../../../README.rst
diff --git a/docs/source/about/usage.rst b/docs/source/about/usage.rst
@@ -1,4 +1,4 @@
-:github_url: https://github.com/LizardByte/plexhints/tree/nightly/docs/source/about/usage.rst
+:github_url: https://github.com/LizardByte/plexhints/blob/master/docs/source/about/usage.rst
 
 Usage
 =====

diff --git a/docs/source/code_docs/main.rst b/docs/source/code_docs/main.rst
@@ -1,4 +1,4 @@
-:github_url: https://github.com/LizardByte/plexhints/tree/nightly/Contents/Code/__init__.py
+:github_url: https://github.com/LizardByte/plexhints/blob/master/Contents/Code/__init__.py
 
 .. include:: ../global.rst
 

diff --git a/docs/source/contributing/build_plugin.rst b/docs/source/contributing/build_plugin.rst
@@ -1,4 +1,4 @@
-:github_url: https://github.com/LizardByte/plexhints/tree/nightly/docs/source/contributing/build_plugin.rst
+:github_url: https://github.com/LizardByte/plexhints/blob/master/docs/source/contributing/build_plugin.rst
 
 Build Plugin
 ============

diff --git a/docs/source/contributing/contributing.rst b/docs/source/contributing/contributing.rst
@@ -1,4 +1,4 @@
-:github_url: https://github.com/LizardByte/plexhints/tree/nightly/docs/source/contributing/contributing.rst
+:github_url: https://github.com/LizardByte/plexhints/blob/master/docs/source/contributing/contributing.rst
 
 Contributing
 ============

diff --git a/docs/source/contributing/testing.rst b/docs/source/contributing/testing.rst
@@ -1,4 +1,4 @@
-:github_url: https://github.com/LizardByte/plexhints/tree/nightly/docs/source/contributing/testing.rst
+:github_url: https://github.com/LizardByte/plexhints/blob/master/docs/source/contributing/testing.rst
 
 Testing
 =======

diff --git a/docs/source/framework/index.rst b/docs/source/framework/index.rst
@@ -1,4 +1,4 @@
-:github_url: https://github.com/LizardByte/plexhints/tree/nightly/docs/source/framework/index.rst
+:github_url: https://github.com/LizardByte/plexhints/blob/master/docs/source/framework/index.rst
 
 Plex Plugin-in Framework documentation
 ======================================

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,4 +1,4 @@
-:github_url: https://github.com/LizardByte/plexhints/tree/nightly/docs/source/index.rst
+:github_url: https://github.com/LizardByte/plexhints/blob/master/docs/source/index.rst
 
 Table of Contents
 =================
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		:github_url: https://github.com/LizardByte/plexhints/blob/master/README.rst

		.. include:: ../../../README.rst