Added pypi publishing. Added docs. Fixed mypy. Added tox testing.
This commit is contained in:
simleek
@@ -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 = .
|
||||
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)
|
||||
@@ -0,0 +1,53 @@
|
||||
# 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('.'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'DisplayArray'
|
||||
copyright = '2019, Simulator Leek'
|
||||
author = 'Simulator Leek'
|
||||
|
||||
|
||||
# -- 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.todo', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# 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 = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
add_module_names = False
|
||||
|
||||
|
||||
# -- 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 = 'alabaster'
|
||||
|
||||
# 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_static_path = ['_static']
|
||||
@@ -0,0 +1,7 @@
|
||||
displayarray.effects.crop
|
||||
===================================
|
||||
|
||||
.. currentmodule:: displayarray.effects.crop
|
||||
|
||||
.. autoclass:: Crop
|
||||
:members:
|
||||
@@ -0,0 +1,12 @@
|
||||
displayarray
|
||||
===================================
|
||||
.. automodule:: displayarray
|
||||
|
||||
Display
|
||||
-------
|
||||
.. autofunction:: display
|
||||
.. autofunction:: breakpoint_display
|
||||
|
||||
Frames
|
||||
------
|
||||
.. autofunction:: read_updates
|
||||
@@ -0,0 +1,5 @@
|
||||
displayarray cli
|
||||
===================================
|
||||
|
||||
.. automodule:: displayarray.__main__
|
||||
:members:
|
||||
@@ -0,0 +1,20 @@
|
||||
displayarray.frame
|
||||
===================================
|
||||
|
||||
.. currentmodule:: displayarray.frame
|
||||
|
||||
.. automodule:: displayarray.frame
|
||||
:members:
|
||||
|
||||
.. autodata: subscriber_dictionary
|
||||
|
||||
.. autoclass:: FrameUpdater
|
||||
:members:
|
||||
|
||||
.. autofunction:: read_updates
|
||||
.. autofunction:: get_cam_ids
|
||||
|
||||
.. autoclass:: NpCam
|
||||
:members:
|
||||
|
||||
.. autofunction:: pub_cam_thread
|
||||
@@ -0,0 +1,36 @@
|
||||
.. DisplayArray documentation master file, created by
|
||||
sphinx-quickstart on Thu Nov 7 21:13:18 2019.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
:github_url: https://github.com/simleek/displayarray
|
||||
|
||||
DisplayArray Documentation
|
||||
========================================
|
||||
|
||||
DisplayArray displays arrays.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: Python API
|
||||
|
||||
displayarray
|
||||
displayarray.effects.crop <crop>
|
||||
displayarray.effects.lens <lens>
|
||||
displayarray.effects.select_channels <select_channels>
|
||||
displayarray.frame <frame>
|
||||
displayarray.window <window>
|
||||
displayarray.input <input>
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Bash API
|
||||
|
||||
displayarray <displayarray_bash>
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
@@ -0,0 +1,19 @@
|
||||
displayarray.input
|
||||
===================================
|
||||
|
||||
.. currentmodule:: displayarray.input
|
||||
|
||||
Mouse Input
|
||||
------------
|
||||
|
||||
.. autoclass:: mouse_loop
|
||||
:members:
|
||||
|
||||
.. autoclass:: MouseEvent
|
||||
:members:
|
||||
|
||||
Key Input
|
||||
------------
|
||||
|
||||
.. autoclass:: key_loop
|
||||
:members:
|
||||
@@ -0,0 +1,16 @@
|
||||
displayarray.effects.lens
|
||||
============================
|
||||
|
||||
.. currentmodule:: displayarray.effects.lens
|
||||
|
||||
.. automodule:: displayarray.effects.lens
|
||||
:members:
|
||||
|
||||
.. autoclass:: ControllableLens
|
||||
:members:
|
||||
|
||||
.. autoclass:: Barrel
|
||||
:members:
|
||||
|
||||
.. autoclass:: Mustache
|
||||
:members:
|
||||
@@ -0,0 +1,35 @@
|
||||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=.
|
||||
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
|
||||
@@ -0,0 +1,7 @@
|
||||
displayarray.effects.select_channels
|
||||
======================================
|
||||
|
||||
.. currentmodule:: displayarray.effects.select_channels
|
||||
|
||||
.. autoclass:: SelectChannels
|
||||
:members:
|
||||
@@ -0,0 +1,7 @@
|
||||
displayarray.window
|
||||
===================================
|
||||
|
||||
.. currentmodule:: displayarray.window
|
||||
|
||||
.. autoclass:: SubscriberWindows
|
||||
:members:
|
||||
Reference in New Issue
Block a user