Improving project structure with Hyper Python.

Signed-off-by: Cliff Hill <xlorep@darkhelm.org>
This commit is contained in:
2021-05-21 13:43:34 -04:00
parent e369ec91ec
commit 1c937afb60
37 changed files with 1817 additions and 143 deletions

1
docs/codeofconduct.rst Normal file
View File

@@ -0,0 +1 @@
.. include:: ../CODE_OF_CONDUCT.rst

15
docs/conf.py Normal file
View File

@@ -0,0 +1,15 @@
"""Sphinx configuration."""
from datetime import datetime
project = "Automated Daily Playlist Generator for Plex Music"
author = "Cliff Hill"
copyright = f"{datetime.now().year}, {author}"
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx_click",
"sphinx_rtd_theme",
]
autodoc_typehints = "description"
html_theme = "sphinx_rtd_theme"

4
docs/contributing.rst Normal file
View File

@@ -0,0 +1,4 @@
.. include:: ../CONTRIBUTING.rst
:end-before: github-only
.. _Code of Conduct: codeofconduct.html

16
docs/index.rst Normal file
View File

@@ -0,0 +1,16 @@
.. include:: ../README.rst
:end-before: github-only
.. _Contributor Guide: contributing.html
.. _Usage: usage.html
.. toctree::
:hidden:
:maxdepth: 1
usage
reference
contributing
Code of Conduct <codeofconduct>
License <license>
Changelog <https://github.com/xlorepdarkhelm/plex-playlist/releases>

1
docs/license.rst Normal file
View File

@@ -0,0 +1 @@
.. include:: ../LICENSE.rst

13
docs/reference.rst Normal file
View File

@@ -0,0 +1,13 @@
Reference
=========
.. contents::
:local:
:backlinks: none
playlist.__main__
-----------------
.. automodule:: playlist.__main__
:members:

3
docs/requirements.txt Normal file
View File

@@ -0,0 +1,3 @@
sphinx==3.5.2
sphinx-click==2.6.0
sphinx-rtd-theme==0.5.1

6
docs/usage.rst Normal file
View File

@@ -0,0 +1,6 @@
Usage
=====
.. click:: playlist.__main__:main
:prog: plex-playlist
:nested: full