updating documentation and plex_posters
This commit is contained in:
20
plex-posters/docs/Makefile
Normal file
20
plex-posters/docs/Makefile
Normal file
@@ -0,0 +1,20 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = source
|
||||
BUILDDIR = build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
35
plex-posters/docs/make.bat
Normal file
35
plex-posters/docs/make.bat
Normal file
@@ -0,0 +1,35 @@
|
||||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=source
|
||||
set BUILDDIR=build
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
|
||||
:end
|
||||
popd
|
||||
@@ -1,373 +0,0 @@
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
|
||||
<meta name="generator" content="pdoc 0.7.2" />
|
||||
<title>plex_posters API documentation</title>
|
||||
<meta name="description" content="" />
|
||||
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
|
||||
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
|
||||
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
|
||||
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
|
||||
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
|
||||
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
|
||||
</head>
|
||||
<body>
|
||||
<main>
|
||||
<article id="content">
|
||||
<header>
|
||||
<h1 class="title">Module <code>plex_posters</code></h1>
|
||||
</header>
|
||||
<section id="section-intro">
|
||||
<details class="source">
|
||||
<summary>
|
||||
<span>Expand source code</span>
|
||||
</summary>
|
||||
<pre><code class="python">from __future__ import annotations
|
||||
from .__version__ import __version__
|
||||
from .lib import export
|
||||
from typing import Type, TypeVar
|
||||
import praw
|
||||
import requests
|
||||
|
||||
__all__ = []
|
||||
|
||||
T_movie_poster_porn_scraper = TypeVar(
|
||||
'T_movie_poster_porn_scraper', bound="movie_poster_porn_scraper"
|
||||
)
|
||||
|
||||
|
||||
@export
|
||||
class movie_poster_porn_scraper(object):
|
||||
|
||||
"""Poster scraper
|
||||
|
||||
Attributes
|
||||
----------
|
||||
reddit_instance : praw.Reddit
|
||||
A praw instance connected to Reddit
|
||||
"""
|
||||
|
||||
def __init__(self, instance: praw.Reddit) -> None:
|
||||
"""
|
||||
Parameters
|
||||
----------
|
||||
instance : praw.Reddit
|
||||
A praw instance connected to Reddit
|
||||
"""
|
||||
super().__init__()
|
||||
self.reddit_instance = instance
|
||||
|
||||
@classmethod
|
||||
def create_instance(
|
||||
cls: Type(T_movie_poster_porn_scraper),
|
||||
client_id: str,
|
||||
client_secret: str,
|
||||
user_agent: str,
|
||||
) -> T_movie_poster_porn_scraper:
|
||||
"""Connect to reddit
|
||||
|
||||
Parameters
|
||||
----------
|
||||
client_id : str
|
||||
a valid client id
|
||||
client_secret : str
|
||||
the secret key for the client
|
||||
user_agent : str
|
||||
a user agent
|
||||
"""
|
||||
reddit_instance = praw.Reddit(
|
||||
client_id=client_id,
|
||||
client_secret=client_secret,
|
||||
user_agent=user_agent,
|
||||
)
|
||||
|
||||
return cls(reddit_instance)
|
||||
|
||||
def get_hot_posters(
|
||||
self: T_movie_poster_porn_scraper,
|
||||
) -> T_movie_poster_porn_scraper:
|
||||
"""
|
||||
"""
|
||||
self._poster_urls = {}
|
||||
for post in self.reddit_instance.subreddit('MoviePosterPorn').hot(
|
||||
limit=10
|
||||
):
|
||||
print(post.title)
|
||||
print(post.url)
|
||||
# print(dir(post))
|
||||
# self._poster_urls.append(post.url)
|
||||
self._poster_urls[post.title] = post.url
|
||||
print(self._poster_urls)
|
||||
return self
|
||||
|
||||
def get_posters(self: T_movie_poster_porn_scraper):
|
||||
"""download the posters
|
||||
|
||||
Returns
|
||||
-------
|
||||
self
|
||||
"""
|
||||
for title, url in self._poster_urls.items():
|
||||
r = requests.get(url)
|
||||
with open('posters/' + title + '.jpg', 'wb') as p:
|
||||
p.write(r.content)
|
||||
return self</code></pre>
|
||||
</details>
|
||||
</section>
|
||||
<section>
|
||||
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
|
||||
<dl>
|
||||
<dt><code class="name"><a title="plex_posters.lib" href="lib/index.html">plex_posters.lib</a></code></dt>
|
||||
<dd>
|
||||
<section class="desc"></section>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section>
|
||||
</section>
|
||||
<section>
|
||||
</section>
|
||||
<section>
|
||||
<h2 class="section-title" id="header-classes">Classes</h2>
|
||||
<dl>
|
||||
<dt id="plex_posters.movie_poster_porn_scraper"><code class="flex name class">
|
||||
<span>class <span class="ident">movie_poster_porn_scraper</span></span>
|
||||
<span>(</span><span>instance)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Poster scraper</p>
|
||||
<h2 id="attributes">Attributes</h2>
|
||||
<dl>
|
||||
<dt><strong><code>reddit_instance</code></strong> : <code>praw.Reddit</code></dt>
|
||||
<dd>A praw instance connected to Reddit</dd>
|
||||
</dl>
|
||||
<h2 id="parameters">Parameters</h2>
|
||||
<dl>
|
||||
<dt><strong><code>instance</code></strong> : <code>praw.Reddit</code></dt>
|
||||
<dd>A praw instance connected to Reddit</dd>
|
||||
</dl></section>
|
||||
<details class="source">
|
||||
<summary>
|
||||
<span>Expand source code</span>
|
||||
</summary>
|
||||
<pre><code class="python">class movie_poster_porn_scraper(object):
|
||||
|
||||
"""Poster scraper
|
||||
|
||||
Attributes
|
||||
----------
|
||||
reddit_instance : praw.Reddit
|
||||
A praw instance connected to Reddit
|
||||
"""
|
||||
|
||||
def __init__(self, instance: praw.Reddit) -> None:
|
||||
"""
|
||||
Parameters
|
||||
----------
|
||||
instance : praw.Reddit
|
||||
A praw instance connected to Reddit
|
||||
"""
|
||||
super().__init__()
|
||||
self.reddit_instance = instance
|
||||
|
||||
@classmethod
|
||||
def create_instance(
|
||||
cls: Type(T_movie_poster_porn_scraper),
|
||||
client_id: str,
|
||||
client_secret: str,
|
||||
user_agent: str,
|
||||
) -> T_movie_poster_porn_scraper:
|
||||
"""Connect to reddit
|
||||
|
||||
Parameters
|
||||
----------
|
||||
client_id : str
|
||||
a valid client id
|
||||
client_secret : str
|
||||
the secret key for the client
|
||||
user_agent : str
|
||||
a user agent
|
||||
"""
|
||||
reddit_instance = praw.Reddit(
|
||||
client_id=client_id,
|
||||
client_secret=client_secret,
|
||||
user_agent=user_agent,
|
||||
)
|
||||
|
||||
return cls(reddit_instance)
|
||||
|
||||
def get_hot_posters(
|
||||
self: T_movie_poster_porn_scraper,
|
||||
) -> T_movie_poster_porn_scraper:
|
||||
"""
|
||||
"""
|
||||
self._poster_urls = {}
|
||||
for post in self.reddit_instance.subreddit('MoviePosterPorn').hot(
|
||||
limit=10
|
||||
):
|
||||
print(post.title)
|
||||
print(post.url)
|
||||
# print(dir(post))
|
||||
# self._poster_urls.append(post.url)
|
||||
self._poster_urls[post.title] = post.url
|
||||
print(self._poster_urls)
|
||||
return self
|
||||
|
||||
def get_posters(self: T_movie_poster_porn_scraper):
|
||||
"""download the posters
|
||||
|
||||
Returns
|
||||
-------
|
||||
self
|
||||
"""
|
||||
for title, url in self._poster_urls.items():
|
||||
r = requests.get(url)
|
||||
with open('posters/' + title + '.jpg', 'wb') as p:
|
||||
p.write(r.content)
|
||||
return self</code></pre>
|
||||
</details>
|
||||
<h3>Static methods</h3>
|
||||
<dl>
|
||||
<dt id="plex_posters.movie_poster_porn_scraper.create_instance"><code class="name flex">
|
||||
<span>def <span class="ident">create_instance</span></span>(<span>client_id, client_secret, user_agent)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Connect to reddit</p>
|
||||
<h2 id="parameters">Parameters</h2>
|
||||
<dl>
|
||||
<dt><strong><code>client_id</code></strong> : <code>str</code></dt>
|
||||
<dd>a valid client id</dd>
|
||||
<dt><strong><code>client_secret</code></strong> : <code>str</code></dt>
|
||||
<dd>the secret key for the client</dd>
|
||||
<dt><strong><code>user_agent</code></strong> : <code>str</code></dt>
|
||||
<dd>a user agent</dd>
|
||||
</dl></section>
|
||||
<details class="source">
|
||||
<summary>
|
||||
<span>Expand source code</span>
|
||||
</summary>
|
||||
<pre><code class="python">@classmethod
|
||||
def create_instance(
|
||||
cls: Type(T_movie_poster_porn_scraper),
|
||||
client_id: str,
|
||||
client_secret: str,
|
||||
user_agent: str,
|
||||
) -> T_movie_poster_porn_scraper:
|
||||
"""Connect to reddit
|
||||
|
||||
Parameters
|
||||
----------
|
||||
client_id : str
|
||||
a valid client id
|
||||
client_secret : str
|
||||
the secret key for the client
|
||||
user_agent : str
|
||||
a user agent
|
||||
"""
|
||||
reddit_instance = praw.Reddit(
|
||||
client_id=client_id,
|
||||
client_secret=client_secret,
|
||||
user_agent=user_agent,
|
||||
)
|
||||
|
||||
return cls(reddit_instance)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3>Methods</h3>
|
||||
<dl>
|
||||
<dt id="plex_posters.movie_poster_porn_scraper.get_hot_posters"><code class="name flex">
|
||||
<span>def <span class="ident">get_hot_posters</span></span>(<span>self)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>
|
||||
<span>Expand source code</span>
|
||||
</summary>
|
||||
<pre><code class="python">def get_hot_posters(
|
||||
self: T_movie_poster_porn_scraper,
|
||||
) -> T_movie_poster_porn_scraper:
|
||||
"""
|
||||
"""
|
||||
self._poster_urls = {}
|
||||
for post in self.reddit_instance.subreddit('MoviePosterPorn').hot(
|
||||
limit=10
|
||||
):
|
||||
print(post.title)
|
||||
print(post.url)
|
||||
# print(dir(post))
|
||||
# self._poster_urls.append(post.url)
|
||||
self._poster_urls[post.title] = post.url
|
||||
print(self._poster_urls)
|
||||
return self</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
<dt id="plex_posters.movie_poster_porn_scraper.get_posters"><code class="name flex">
|
||||
<span>def <span class="ident">get_posters</span></span>(<span>self)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>download the posters</p>
|
||||
<h2 id="returns">Returns</h2>
|
||||
<dl>
|
||||
<dt><code>self</code></dt>
|
||||
<dd> </dd>
|
||||
</dl></section>
|
||||
<details class="source">
|
||||
<summary>
|
||||
<span>Expand source code</span>
|
||||
</summary>
|
||||
<pre><code class="python">def get_posters(self: T_movie_poster_porn_scraper):
|
||||
"""download the posters
|
||||
|
||||
Returns
|
||||
-------
|
||||
self
|
||||
"""
|
||||
for title, url in self._poster_urls.items():
|
||||
r = requests.get(url)
|
||||
with open('posters/' + title + '.jpg', 'wb') as p:
|
||||
p.write(r.content)
|
||||
return self</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</article>
|
||||
<nav id="sidebar">
|
||||
<h1>Index</h1>
|
||||
<div class="toc">
|
||||
<ul></ul>
|
||||
</div>
|
||||
<ul id="index">
|
||||
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
|
||||
<ul>
|
||||
<li><code><a title="plex_posters.lib" href="lib/index.html">plex_posters.lib</a></code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><h3><a href="#header-classes">Classes</a></h3>
|
||||
<ul>
|
||||
<li>
|
||||
<h4><code><a title="plex_posters.movie_poster_porn_scraper" href="#plex_posters.movie_poster_porn_scraper">movie_poster_porn_scraper</a></code></h4>
|
||||
<ul class="">
|
||||
<li><code><a title="plex_posters.movie_poster_porn_scraper.create_instance" href="#plex_posters.movie_poster_porn_scraper.create_instance">create_instance</a></code></li>
|
||||
<li><code><a title="plex_posters.movie_poster_porn_scraper.get_hot_posters" href="#plex_posters.movie_poster_porn_scraper.get_hot_posters">get_hot_posters</a></code></li>
|
||||
<li><code><a title="plex_posters.movie_poster_porn_scraper.get_posters" href="#plex_posters.movie_poster_porn_scraper.get_posters">get_posters</a></code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</main>
|
||||
<footer id="footer">
|
||||
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.2</a>.</p>
|
||||
</footer>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad()</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,94 +0,0 @@
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
|
||||
<meta name="generator" content="pdoc 0.7.2" />
|
||||
<title>plex_posters.lib API documentation</title>
|
||||
<meta name="description" content="" />
|
||||
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
|
||||
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
|
||||
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
|
||||
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
|
||||
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
|
||||
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
|
||||
</head>
|
||||
<body>
|
||||
<main>
|
||||
<article id="content">
|
||||
<header>
|
||||
<h1 class="title">Module <code>plex_posters.lib</code></h1>
|
||||
</header>
|
||||
<section id="section-intro">
|
||||
<details class="source">
|
||||
<summary>
|
||||
<span>Expand source code</span>
|
||||
</summary>
|
||||
<pre><code class="python">import sys
|
||||
|
||||
|
||||
def export(fn):
|
||||
mod = sys.modules[fn.__module__]
|
||||
if hasattr(mod, '__all__'):
|
||||
mod.__all__.append(fn.__name__)
|
||||
else:
|
||||
mod.__all__ = [fn.__name__]
|
||||
return fn</code></pre>
|
||||
</details>
|
||||
</section>
|
||||
<section>
|
||||
</section>
|
||||
<section>
|
||||
</section>
|
||||
<section>
|
||||
<h2 class="section-title" id="header-functions">Functions</h2>
|
||||
<dl>
|
||||
<dt id="plex_posters.lib.export"><code class="name flex">
|
||||
<span>def <span class="ident">export</span></span>(<span>fn)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>
|
||||
<span>Expand source code</span>
|
||||
</summary>
|
||||
<pre><code class="python">def export(fn):
|
||||
mod = sys.modules[fn.__module__]
|
||||
if hasattr(mod, '__all__'):
|
||||
mod.__all__.append(fn.__name__)
|
||||
else:
|
||||
mod.__all__ = [fn.__name__]
|
||||
return fn</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section>
|
||||
</section>
|
||||
</article>
|
||||
<nav id="sidebar">
|
||||
<h1>Index</h1>
|
||||
<div class="toc">
|
||||
<ul></ul>
|
||||
</div>
|
||||
<ul id="index">
|
||||
<li><h3>Super-module</h3>
|
||||
<ul>
|
||||
<li><code><a title="plex_posters" href="../index.html">plex_posters</a></code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><h3><a href="#header-functions">Functions</a></h3>
|
||||
<ul class="">
|
||||
<li><code><a title="plex_posters.lib.export" href="#plex_posters.lib.export">export</a></code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</main>
|
||||
<footer id="footer">
|
||||
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.2</a>.</p>
|
||||
</footer>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad()</script>
|
||||
</body>
|
||||
</html>
|
||||
31
plex-posters/docs/source/_static/custom.css
Normal file
31
plex-posters/docs/source/_static/custom.css
Normal file
@@ -0,0 +1,31 @@
|
||||
@import url("css/theme.css");
|
||||
|
||||
.modname {
|
||||
font-size: 0.8em;
|
||||
opacity: 0.4;
|
||||
}
|
||||
.modname::before {
|
||||
content: '- ';
|
||||
}
|
||||
.title {
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
background-color: #eee;
|
||||
display: block;
|
||||
padding: 1px 5px;
|
||||
border-left: 2px solid #ddd;
|
||||
}
|
||||
|
||||
.wy-menu-vertical header, .wy-menu-vertical p.caption{
|
||||
color: ##466A54;;
|
||||
}
|
||||
|
||||
.wy-side-nav-search{
|
||||
background-color: #0E6458;
|
||||
}
|
||||
|
||||
.rst-content dl:not(.docutils) dt{
|
||||
background: #F2E7D3;
|
||||
color: #499265;
|
||||
border-top: solid 3px #87CB7C;
|
||||
}
|
||||
7
plex-posters/docs/source/changelog.rst
Normal file
7
plex-posters/docs/source/changelog.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
Version history
|
||||
================
|
||||
|
||||
0.1.0 (28/11/19)
|
||||
----------------
|
||||
|
||||
- Initial release.
|
||||
94
plex-posters/docs/source/conf.py
Normal file
94
plex-posters/docs/source/conf.py
Normal file
@@ -0,0 +1,94 @@
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
import plex_posters
|
||||
from plex_posters.__version__ import __version__ as version
|
||||
import sphinx_rtd_theme
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'plex_posters'
|
||||
copyright = '2019, Daniel Tomlinson'
|
||||
author = 'Daniel Tomlinson'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = version
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinx.ext.napoleon',
|
||||
'sphinx.ext.todo',
|
||||
]
|
||||
|
||||
# -- Napoleon Settings -----------------------------------------------------
|
||||
napoleon_google_docstring = False
|
||||
napoleon_numpy_docstring = True
|
||||
napoleon_include_init_with_doc = True
|
||||
napoleon_include_private_with_doc = False
|
||||
napoleon_include_special_with_doc = False
|
||||
napoleon_use_admonition_for_examples = False
|
||||
napoleon_use_admonition_for_notes = False
|
||||
napoleon_use_admonition_for_references = False
|
||||
napoleon_use_ivar = True
|
||||
napoleon_use_param = True
|
||||
napoleon_use_rtype = True
|
||||
napoleon_use_keyword = True
|
||||
autodoc_member_order = 'bysource'
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = []
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||||
html_static_path = ['_static']
|
||||
html_context = {'css_files': ['_static/custom.css']}
|
||||
html_theme_options = {
|
||||
'collapse_navigation': True,
|
||||
'display_version': True,
|
||||
#'navigation_depth': 3,
|
||||
}
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# Enable todo
|
||||
todo_include_todos = True
|
||||
4
plex-posters/docs/source/configuration.rst
Normal file
4
plex-posters/docs/source/configuration.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
Configuration
|
||||
=============
|
||||
|
||||
.. todo:: fill in configuration options
|
||||
5
plex-posters/docs/source/global.rst
Normal file
5
plex-posters/docs/source/global.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
.. role:: modname
|
||||
:class: modname
|
||||
|
||||
.. role:: title
|
||||
:class: title
|
||||
3
plex-posters/docs/source/index.rst
Normal file
3
plex-posters/docs/source/index.rst
Normal file
@@ -0,0 +1,3 @@
|
||||
Table of Contents
|
||||
=================
|
||||
.. include:: toc.rst
|
||||
1
plex-posters/docs/source/introduction.rst
Normal file
1
plex-posters/docs/source/introduction.rst
Normal file
@@ -0,0 +1 @@
|
||||
.. include:: ../../README.rst
|
||||
7
plex-posters/docs/source/modules/modules.rst
Normal file
7
plex-posters/docs/source/modules/modules.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
plex_posters
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
plex_posters
|
||||
@@ -0,0 +1,9 @@
|
||||
.. include:: ../global.rst
|
||||
|
||||
Config :modname:`plex_posters.config.config`
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: plex_posters.config.config
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
16
plex-posters/docs/source/modules/plex_posters.config.rst
Normal file
16
plex-posters/docs/source/modules/plex_posters.config.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
.. include:: ../global.rst
|
||||
|
||||
Config :modname:`plex_posters.config`
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: plex_posters.config
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
plex_posters.config.config
|
||||
9
plex-posters/docs/source/modules/plex_posters.lib.rst
Normal file
9
plex-posters/docs/source/modules/plex_posters.lib.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
.. include:: ../global.rst
|
||||
|
||||
Lib :modname:`plex_posters.lib`
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: plex_posters.lib
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
17
plex-posters/docs/source/modules/plex_posters.rst
Normal file
17
plex-posters/docs/source/modules/plex_posters.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
.. include:: ../global.rst
|
||||
|
||||
plex_posters :modname:`plex_posters`
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: plex_posters
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
plex_posters.config
|
||||
plex_posters.lib
|
||||
24
plex-posters/docs/source/toc.rst
Normal file
24
plex-posters/docs/source/toc.rst
Normal file
@@ -0,0 +1,24 @@
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Overview
|
||||
:titlesonly:
|
||||
|
||||
introduction
|
||||
configuration
|
||||
changelog
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:caption: Modules
|
||||
:titlesonly:
|
||||
|
||||
modules/plex_posters.rst
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:caption: Submodules
|
||||
:titlesonly:
|
||||
|
||||
modules/plex_posters.config.config.rst
|
||||
modules/plex_posters.lib.rst
|
||||
|
||||
Reference in New Issue
Block a user