Include Stream class in API docs

This commit is contained in:
Karl Kroening 2019-06-03 01:32:44 -05:00
parent 881ae4efff
commit 5c4a5c720f
6 changed files with 64 additions and 45 deletions

View File

@ -1,10 +1,22 @@
from __future__ import unicode_literals from __future__ import unicode_literals
from . import nodes
from . import _filters, _ffmpeg, _run, _probe from . import _ffmpeg
from ._filters import * from . import _filters
from . import _probe
from . import _run
from . import _view
from .nodes import *
from ._ffmpeg import * from ._ffmpeg import *
from ._filters import *
from ._probe import *
from ._run import * from ._run import *
from ._view import * from ._view import *
from ._probe import *
__all__ = _filters.__all__ + _ffmpeg.__all__ + _run.__all__ + _view.__all__ + _probe.__all__ __all__ = (
nodes.__all__
+ _ffmpeg.__all__
+ _probe.__all__
+ _run.__all__
+ _view.__all__
+ _filters.__all__
)

View File

@ -8,7 +8,7 @@ from ._utils import escape_chars
def filter_multi_output(stream_spec, filter_name, *args, **kwargs): def filter_multi_output(stream_spec, filter_name, *args, **kwargs):
"""Apply custom filter with one or more outputs. """Apply custom filter with one or more outputs.
This is the same as ``filter_`` except that the filter can produce more than one output. This is the same as ``filter`` except that the filter can produce more than one output.
To reference an output stream, use either the ``.stream`` operator or bracket shorthand: To reference an output stream, use either the ``.stream`` operator or bracket shorthand:

View File

@ -336,3 +336,8 @@ def filter_operator(name=None):
def output_operator(name=None): def output_operator(name=None):
return stream_operator(stream_classes={OutputStream}, name=name) return stream_operator(stream_classes={OutputStream}, name=name)
__all__ = [
'Stream',
]

View File

@ -1,6 +0,0 @@
future
pytest
pytest-mock
pytest-runner
sphinx
tox

View File

@ -1,33 +1,39 @@
alabaster==0.7.10 alabaster==0.7.12
apipkg==1.4 atomicwrites==1.3.0
Babel==2.5.1 attrs==19.1.0
certifi==2017.7.27.1 Babel==2.7.0
certifi==2019.3.9
chardet==3.0.4 chardet==3.0.4
docutils==0.14 docutils==0.14
execnet==1.5.0 filelock==3.0.12
funcsigs==1.0.2 future==0.17.1
future==0.16.0 idna==2.8
idna==2.6 imagesize==1.1.0
imagesize==0.7.1 importlib-metadata==0.17
Jinja2==2.9.6 Jinja2==2.10.1
MarkupSafe==1.0 MarkupSafe==1.1.1
mock==2.0.0 more-itertools==7.0.0
pbr==4.0.3 packaging==19.0
pluggy==0.5.2 pluggy==0.12.0
py==1.4.34 py==1.8.0
Pygments==2.2.0 Pygments==2.4.2
pytest==3.2.3 pyparsing==2.4.0
pytest-forked==0.2 pytest==4.6.1
pytest-mock==1.10.0 pytest-mock==1.10.4
pytest-runner==3.0 pytz==2019.1
pytest-xdist==1.22.2 requests==2.22.0
pytz==2017.3 six==1.12.0
requests==2.18.4
six==1.11.0
snowballstemmer==1.2.1 snowballstemmer==1.2.1
Sphinx==1.6.5 Sphinx==2.1.0
sphinxcontrib-websupport==1.0.1 sphinxcontrib-applehelp==1.0.1
tox==2.9.1 sphinxcontrib-devhelp==1.0.1
typing==3.6.2 sphinxcontrib-htmlhelp==1.0.2
urllib3==1.22 sphinxcontrib-jsmath==1.0.1
virtualenv==15.1.0 sphinxcontrib-qthelp==1.0.2
sphinxcontrib-serializinghtml==1.1.3
toml==0.10.0
tox==3.12.1
urllib3==1.25.3
virtualenv==16.6.0
wcwidth==0.1.7
zipp==0.5.1

View File

@ -69,9 +69,11 @@ setup(
install_requires=['future'], install_requires=['future'],
extras_require={ extras_require={
'dev': [ 'dev': [
'future', 'future==0.17.1',
'pytest', 'pytest-mock==1.10.4',
'pytest-mock', 'pytest==4.6.1',
'Sphinx==2.1.0',
'tox==3.12.1',
], ],
}, },
classifiers=[ classifiers=[