Project restructuring.

Signed-off-by: Cliff Hill <xlorep@darkhelm.org>
This commit is contained in:
2024-04-24 12:15:45 -04:00
parent d914215f47
commit f51109f08a
12 changed files with 6 additions and 6 deletions

View File

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

12
backend/docs/conf.py Normal file
View File

@@ -0,0 +1,12 @@
"""Sphinx configuration."""
project = "Plex Playlist"
author = "Cliff Hill"
copyright = "2023, Cliff Hill"
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx_click",
"myst_parser",
]
autodoc_typehints = "description"
html_theme = "furo"

View File

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

23
backend/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
backend/docs/license.md Normal file
View File

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

View File

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

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
backend/docs/usage.md Normal file
View File

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