Skip to content
This repository was archived by the owner on Aug 9, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 23 additions & 22 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
2 changes: 1 addition & 1 deletion docs/source/about/github_action.rst
Original file line number Diff line number Diff line change
@@ -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
=============
Expand Down
2 changes: 1 addition & 1 deletion docs/source/about/installation.rst
Original file line number Diff line number Diff line change
@@ -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
============
Expand Down
2 changes: 2 additions & 0 deletions docs/source/about/overview.rst
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
2 changes: 1 addition & 1 deletion docs/source/about/usage.rst
Original file line number Diff line number Diff line change
@@ -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
=====
Expand Down
2 changes: 1 addition & 1 deletion docs/source/code_docs/main.rst
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing/build_plugin.rst
Original file line number Diff line number Diff line change
@@ -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
============
Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing/contributing.rst
Original file line number Diff line number Diff line change
@@ -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
============
Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing/testing.rst
Original file line number Diff line number Diff line change
@@ -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
=======
Expand Down
2 changes: 1 addition & 1 deletion docs/source/framework/index.rst
Original file line number Diff line number Diff line change
@@ -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
======================================
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -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
=================
Expand Down