Febbweiss/mopidy-touchscreen
1
0
Fork 0
mirror of https://github.com/Febbweiss/mopidy-touchscreen.git synced 2026-03-04 22:25:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs initial

Browse Source
This commit is contained in:
Ander
2015-05-20 00:26:27 +02:00
parent 31c3d6d3c1
commit f2b4a89da6
12 changed files with 42 additions and 218 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Makefile
View File

@@ -5,7 +5,7 @@
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
@@ -15,9 +15,9 @@ endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext

15
docs/source/conf.py → docs/conf.py
View File

@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
#
# Mopidy Touchscreen documentation build configuration file, created by
# sphinx-quickstart on Tue May 19 21:55:21 2015.
# sphinx-quickstart on Tue May 19 23:33:30 2015.
#
# This file is execfile()d with the current directory set to its
# containing dir.
@@ -31,7 +31,6 @@ import shlex
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.coverage',
]
# Add any paths that contain templates here, relative to this directory.
@@ -58,9 +57,9 @@ author = u'9and3r'
# built documents.
#
# The short X.Y version.
version = '4.0.0'
version = '0.4.0'
# The full version, including alpha/beta/rc tags.
release = '4.0.0'
release = '0.4.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -77,7 +76,7 @@ language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
@@ -286,4 +285,8 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
os.path.abspath('../mopidy-touchscreen')
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

7
docs/how_to_install.rst Normal file
View File

@@ -0,0 +1,7 @@
**************
How to install
**************
.. image:: https://img.shields.io/pypi/v/Mopidy-Touchscreen.svg?style=flat
:target: https://pypi.python.org/pypi/Mopidy-Touchscreen/
:alt: Latest PyPI version

19
docs/source/index.rst → docs/index.rst
View File

@@ -195,19 +195,10 @@ v0.2.0 (2014-08-02)
- First working version
Contents:
.. toctree::
:maxdepth: 2
.. automodule:: screens
.. autoclass:: BaseScreen
:members:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
how_to_install
source_code/index

6
docs/make.bat
View File

@@ -5,9 +5,9 @@ REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
set I18NSPHINXOPTS=%SPHINXOPTS% source
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
set I18NSPHINXOPTS=%SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%

7
docs/source/modules.rst
View File

@@ -1,7 +0,0 @@
.
=
.. toctree::
:maxdepth: 4
mopidy_touchscreen

38
docs/source/mopidy_touchscreen.graphic_utils.rst
View File

@@ -1,38 +0,0 @@
mopidy_touchscreen.graphic_utils package
========================================
Submodules
----------
mopidy_touchscreen.graphic_utils.background_manager module
----------------------------------------------------------
.. automodule:: mopidy_touchscreen.graphic_utils.background_manager
:members:
:undoc-members:
:show-inheritance:
mopidy_touchscreen.graphic_utils.list_view module
-------------------------------------------------
.. automodule:: mopidy_touchscreen.graphic_utils.list_view
:members:
:undoc-members:
:show-inheritance:
mopidy_touchscreen.graphic_utils.screen_objects module
------------------------------------------------------
.. automodule:: mopidy_touchscreen.graphic_utils.screen_objects
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mopidy_touchscreen.graphic_utils
:members:
:undoc-members:
:show-inheritance:

30
docs/source/mopidy_touchscreen.input.rst
View File

@@ -1,30 +0,0 @@
mopidy_touchscreen.input package
================================
Submodules
----------
mopidy_touchscreen.input.gpio_inpput_manager module
---------------------------------------------------
.. automodule:: mopidy_touchscreen.input.gpio_inpput_manager
:members:
:undoc-members:
:show-inheritance:
mopidy_touchscreen.input.input_manager module
---------------------------------------------
.. automodule:: mopidy_touchscreen.input.input_manager
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mopidy_touchscreen.input
:members:
:undoc-members:
:show-inheritance:

39
docs/source/mopidy_touchscreen.rst
View File

@@ -1,39 +0,0 @@
mopidy_touchscreen package
==========================
Subpackages
-----------
.. toctree::
mopidy_touchscreen.graphic_utils
mopidy_touchscreen.input
mopidy_touchscreen.screens
Submodules
----------
mopidy_touchscreen.screen_manager module
----------------------------------------
.. automodule:: mopidy_touchscreen.screen_manager
:members:
:undoc-members:
:show-inheritance:
mopidy_touchscreen.touch_screen module
--------------------------------------
.. automodule:: mopidy_touchscreen.touch_screen
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mopidy_touchscreen
:members:
:undoc-members:
:show-inheritance:

78
docs/source/mopidy_touchscreen.screens.rst
View File

@@ -1,78 +0,0 @@
mopidy_touchscreen.screens package
==================================
Submodules
----------
mopidy_touchscreen.screens.base_screen module
---------------------------------------------
.. automodule:: mopidy_touchscreen.screens.base_screen
:members:
:undoc-members:
:show-inheritance:
mopidy_touchscreen.screens.keyboard_screen module
-------------------------------------------------
.. automodule:: mopidy_touchscreen.screens.keyboard_screen
:members:
:undoc-members:
:show-inheritance:
mopidy_touchscreen.screens.library_screen module
------------------------------------------------
.. automodule:: mopidy_touchscreen.screens.library_screen
:members:
:undoc-members:
:show-inheritance:
mopidy_touchscreen.screens.main_screen module
---------------------------------------------
.. automodule:: mopidy_touchscreen.screens.main_screen
:members:
:undoc-members:
:show-inheritance:
mopidy_touchscreen.screens.menu_screen module
---------------------------------------------
.. automodule:: mopidy_touchscreen.screens.menu_screen
:members:
:undoc-members:
:show-inheritance:
mopidy_touchscreen.screens.playlist_screen module
-------------------------------------------------
.. automodule:: mopidy_touchscreen.screens.playlist_screen
:members:
:undoc-members:
:show-inheritance:
mopidy_touchscreen.screens.search_screen module
-----------------------------------------------
.. automodule:: mopidy_touchscreen.screens.search_screen
:members:
:undoc-members:
:show-inheritance:
mopidy_touchscreen.screens.tracklist module
-------------------------------------------
.. automodule:: mopidy_touchscreen.screens.tracklist
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: mopidy_touchscreen.screens
:members:
:undoc-members:
:show-inheritance:

8
docs/source_code/index.rst Normal file
View File

@@ -0,0 +1,8 @@
*********************
Source Code Reference
*********************
.. automodule:: mopidy_touchscreen
:members:
:undoc-members:
:show-inheritance:

7
mopidy_touchscreen/screens/base_screen.py
View File

@@ -11,6 +11,13 @@ class BaseScreen():
self.fonts = fonts
def update(self, surface, update_type, rects):
"""
Draw this screen to the surface
:param surface:
:param update_type:
:param rects:
"""
pass
def event(self, event):