From 0adc03d4ecdb9918c1e10a6bcb2239ae2ec0a134 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Wed, 24 Jul 2024 19:50:03 -0400 Subject: [PATCH] docs: add pypi badge (#241) --- README.rst | 45 ++++++++++++----------- docs/source/about/github_action.rst | 2 +- docs/source/about/installation.rst | 2 +- docs/source/about/overview.rst | 2 + docs/source/about/usage.rst | 2 +- docs/source/code_docs/main.rst | 2 +- docs/source/contributing/build_plugin.rst | 2 +- docs/source/contributing/contributing.rst | 2 +- docs/source/contributing/testing.rst | 2 +- docs/source/framework/index.rst | 2 +- docs/source/index.rst | 2 +- 11 files changed, 34 insertions(+), 31 deletions(-) diff --git a/README.rst b/README.rst index 4cd3781..1461d7f 100644 --- 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 `__. - -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 `__. + +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 index 3e698ad..b1b70ae 100644 --- 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 index a47a6c2..bf3a553 100644 --- 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 index e4a3ad5..0062516 100644 --- 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 index 581e171..fc41f34 100644 --- 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 index f4fcaa0..e4cc5a9 100644 --- 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 index 6651e99..566afde 100644 --- 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 index 4a95de2..2d1a4d2 100644 --- 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 index 27d7502..48ce5f9 100644 --- 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 index b0010da..19117a6 100644 --- 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 index ffa3f0b..8ab04fa 100644 --- 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 =================