Added cookiecutter.
Some checks failed
Tests / tests 3.10 / macos-latest (push) Has been cancelled
Tests / docs-build 3.10 / ubuntu-latest (push) Has been cancelled
Tests / mypy 3.10 / ubuntu-latest (push) Has been cancelled
Tests / pre-commit 3.10 / ubuntu-latest (push) Has been cancelled
Tests / safety 3.10 / ubuntu-latest (push) Has been cancelled
Tests / tests 3.10 / ubuntu-latest (push) Has been cancelled
Tests / typeguard 3.10 / ubuntu-latest (push) Has been cancelled
Tests / xdoctest 3.10 / ubuntu-latest (push) Has been cancelled
Tests / mypy 3.7 / ubuntu-latest (push) Has been cancelled
Tests / tests 3.7 / ubuntu-latest (push) Has been cancelled
Tests / mypy 3.8 / ubuntu-latest (push) Has been cancelled
Tests / tests 3.8 / ubuntu-latest (push) Has been cancelled
Tests / mypy 3.9 / ubuntu-latest (push) Has been cancelled
Tests / tests 3.9 / ubuntu-latest (push) Has been cancelled
Tests / tests 3.10 / windows-latest (push) Has been cancelled
Tests / coverage (push) Has been cancelled

Signed-off-by: Cliff Hill <xlorep@darkhelm.org>
This commit is contained in:
2025-03-08 13:05:57 -05:00
parent 57e051b45c
commit 8f709877bc
33 changed files with 2853 additions and 49 deletions

3
docs/codeofconduct.md Normal file
View File

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

12
docs/conf.py Normal file
View File

@@ -0,0 +1,12 @@
"""Sphinx configuration."""
project = "Plex Playlist"
author = "Cliff Hill"
copyright = "2025, Cliff Hill"
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx_click",
"myst_parser",
]
autodoc_typehints = "description"
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

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>
```

7
docs/license.md Normal file
View File

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

8
docs/reference.md Normal file
View File

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

4
docs/requirements.txt Normal file
View File

@@ -0,0 +1,4 @@
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:: playlist.__main__:main
:prog: plex-playlist
:nested: full
```