Initial commit.
Some checks are pending
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (macos-latest, 3.10, tests) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (ubuntu-latest, 3.10, docs-build) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (ubuntu-latest, 3.10, mypy) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (ubuntu-latest, 3.10, pre-commit) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (ubuntu-latest, 3.10, safety) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (ubuntu-latest, 3.10, tests) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (ubuntu-latest, 3.10, typeguard) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (ubuntu-latest, 3.10, xdoctest) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (ubuntu-latest, 3.7, mypy) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (ubuntu-latest, 3.7, tests) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (ubuntu-latest, 3.8, mypy) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (ubuntu-latest, 3.8, tests) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (ubuntu-latest, 3.9, mypy) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (ubuntu-latest, 3.9, tests) (push) Waiting to run
Tests / ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }} (windows-latest, 3.10, tests) (push) Waiting to run
Tests / coverage (push) Blocked by required conditions

Signed-off-by: Cliff Hill <xlorep@darkhelm.org>
This commit is contained in:
2024-09-19 14:15:00 -04:00
parent e90abe3698
commit 6be20af94f
59 changed files with 2501 additions and 4757 deletions

3
docs/codeofconduct.md Normal file
View File

@@ -0,0 +1,3 @@
```{include} ../CODE_OF_CONDUCT.md
```

View File

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

View File

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

7
docs/contributing.md Normal file
View File

@@ -0,0 +1,7 @@
```{include} ../CONTRIBUTING.md
---
end-before: <!-- github-only -->
---
```
[code of conduct]: codeofconduct

View File

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

23
docs/index.md Normal file
View File

@@ -0,0 +1,23 @@
```{include} ../README.md
---
end-before: <!-- github-only -->
---
```
[license]: license
[contributor guide]: contributing
[command-line reference]: usage
```{toctree}
---
hidden:
maxdepth: 1
---
usage
reference
contributing
Code of Conduct <codeofconduct>
License <license>
Changelog <https://github.com/xlorepdarkhelm/plex-playlist/releases>
```

View File

@@ -1,16 +0,0 @@
.. 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>

7
docs/license.md Normal file
View File

@@ -0,0 +1,7 @@
# License
```{literalinclude} ../LICENSE
---
language: none
---
```

View File

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

8
docs/reference.md Normal file
View File

@@ -0,0 +1,8 @@
# Reference
## xdh.playlist
```{eval-rst}
.. automodule:: xdh.playlist
:members:
```

View File

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

View File

@@ -1,3 +1,4 @@
sphinx==3.5.2
sphinx-click==2.6.0
sphinx-rtd-theme==0.5.1
furo==2022.4.7
sphinx==4.5.0
sphinx-click==4.1.0
myst_parser==0.17.2

7
docs/usage.md Normal file
View File

@@ -0,0 +1,7 @@
# Usage
```{eval-rst}
.. click:: xdh.playlist.__main__:main
:prog: plex-playlist
:nested: full
```

View File

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