diff --git a/docs/Makefile b/docs/Makefile index 6d23234..02a9d7b 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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,11 +15,11 @@ endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source # the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext help: @echo "Please use \`make ' where is one of" @@ -30,6 +30,7 @@ help: @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @@ -45,6 +46,7 @@ help: @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" clean: rm -rf $(BUILDDIR)/* @@ -85,17 +87,25 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Mopidy-Touchscreen.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/MopidyTouchscreen.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Mopidy-Touchscreen.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MopidyTouchscreen.qhc" + +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/Mopidy-Touchscreen" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Mopidy-Touchscreen" + @echo "# mkdir -p $$HOME/.local/share/devhelp/MopidyTouchscreen" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MopidyTouchscreen" @echo "# devhelp" epub: @@ -166,6 +176,11 @@ doctest: @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + xml: $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml @echo diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 776a179..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,259 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Mopidy-Touchscreen documentation build configuration file, created by -# sphinx-quickstart on Mon Aug 4 00:48:14 2014. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# import sys -# import os - -# 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. -# sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Mopidy-Touchscreen' -copyright = u'2014, 9and3r' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '0.2.1' -# The full version, including alpha/beta/rc tags. -release = '0.2.1' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = 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 = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# 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'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Mopidy-Touchscreendoc' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = {} -# The paper size ('letterpaper' or 'a4paper'). -# 'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -# 'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -# 'preamble': '', -# } - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('index', 'Mopidy-Touchscreen.tex', - u'Mopidy-Touchscreen Documentation', - u'9and3r', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'mopidy-touchscreen', u'Mopidy-Touchscreen Documentation', - [u'9and3r'], 1) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'Mopidy-Touchscreen', u'Mopidy-Touchscreen Documentation', - u'9and3r', 'Mopidy-Touchscreen', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 2f8582a..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,177 +0,0 @@ -**************************** -Mopidy-Touchscreen -**************************** - -.. image:: https://img.shields.io/pypi/v/Mopidy-Touchscreen.svg?style=flat - :target: https://pypi.python.org/pypi/Mopidy-Touchscreen/ - :alt: Latest PyPI version - -.. image:: https://img.shields.io/pypi/dm/Mopidy-Touchscreen.svg?style=flat - :target: https://pypi.python.org/pypi/Mopidy-Touchscreen/ - :alt: Number of PyPI downloads - -.. image:: https://img.shields.io/travis/9and3r/mopidy-touchscreen/master.png?style=flat - :target: https://travis-ci.org/9and3r/mopidy-touchscreen - :alt: Travis CI build status - -.. image:: https://img.shields.io/coveralls/9and3r/mopidy-touchscreen/master.svg?style=flat - :target: https://coveralls.io/r/9and3r/mopidy-touchscreen?branch=master - :alt: Test coverage - -Extension for displaying track info and controlling Mopidy from a touch screen using `PyGame `_/SDL. - -Cover images are downloaded from `last.fm `_ - -Dependencies -============ - -- ``Mopidy`` >= 0.18 -- ``Pykka`` >= 1.1 -- ``pygame`` - -Installation -============ - -Install by running:: - - pip install Mopidy-Touchscreen - -Or, if available, install the Debian/Ubuntu package from `apt.mopidy.com -`_. - - -Basic Configuration -=================== - -Before starting Mopidy, you must add configuration for -Mopidy-Touchscreen to your Mopidy configuration file:: - - [touchscreen] - enabled = true - screen_width = 320 - screen_height = 240 - cursor = True - fullscreen = False - cache_dir = $XDG_CACHE_DIR/mopidy/touchscreen - -The following configuration values are available: - -- ``touchscreen/enabled``: If the Touchscreen extension should be enabled or not. -- ``touchscreen/screen_width``: The width of the resolution you want to use in pixels. -- ``touchscreen/screen_height``: The width of the resolution you want to use in pixels. -- ``touchscreen/cursor``: If the mouse cursor should be shown. (If you use a touchscreen it should be false) -- ``touchscreen/fullscreen``: If you want to be shown as a window or in fullscreen. -- ``touchscreen/screen_width``: The folder to be used as cache. Defaults to ``$XDG_CACHE_DIR/mopidy/touchscreen``, which usually means - ``~/.cache/mopidy/touchscreen`` - - -How to Setup -============ - -Use the basic configuration to setup as most standard screens works fine without further configuration. - -Raspberry Pi and LCD Shields ----------------------------- - -If you are using a LCD Shield in Raspberry Pi you need to config your LCD and run mopidy with root privileges: - -Configure your LCD Shield -````````````````````````` - -Add to the config the next variables:: - - [touchscreen] - sdl_fbdev = /dev/fb1 - sdl_mousdrv = TSLIB - sdl_mousedev = event0 - -This is just an example. It may work but each LCD Shield seems to have its own configuration. -To find your values find an example of using pygame with your LCD Shield and it should be something like this in the code:: - - os.environ["SDL_FBDEV"] = "/dev/fb1" - os.environ["SDL_MOUSEDRV"] = "TSLIB" - os.environ["SDL_MOUSEDEV"] = "event0" - -Run mopidy with root privileges -``````````````````````````````` - -You can use ``sudo mopidy``. - -In case you are using musicbox edit ``/etc/init.d/mopidy`` file. Change ``DAEMON_USER=mopidy`` to ``DAEMON_USER=root`` - -Do not forget that this is a workaround and that mopidy will run with root privileges. - - -Help -==== - -You can use `mopidy discuss `_ -or send an email to `9and3r@gmail.com `_ - -Features -======== - -Working -------- - -* See track info (track name, album, artist, cover image) -* Seek Track -* Play/Pause -* Mute/Unmute -* Change volume -* Next/Previous track -* Library -* Menu (exit mopidy, restart...) -* Shuffle on/off -* Repeat one/on/off -* Playback list and song selection -* Playlists - -Planned -------- - -* Use keyboard or GPIO buttons instead of touchscreen - -Screenshots -=========== - -.. image:: http://i60.tinypic.com/qqsait.jpg - -Video -===== - -`Example video running the extension `_ - -Project resources -================= - -- `Source code `_ -- `Issue tracker `_ -- `Download development snapshot `_ - - -Changelog -========= - -v0.3.2 ----------------------------------------- - -- Bug Fixes -- UI changes -- Smoth text scrolling -- Search albums, artist or songs (Not fully implemented. Basic functionality) - -v0.2.1 ----------------------------------------- - -- Font will be included on installation - -v0.2.0 ----------------------------------------- - -- First working version - -v0.1.0 (UNRELEASED) ----------------------------------------- - -- Initial release. diff --git a/docs/make.bat b/docs/make.bat index 95b1665..708aacf 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -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% . -set I18NSPHINXOPTS=%SPHINXOPTS% . +set BUILDDIR=build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source +set I18NSPHINXOPTS=%SPHINXOPTS% source if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% @@ -37,6 +37,7 @@ if "%1" == "help" ( echo. pseudoxml to make pseudoxml-XML files for display purposes echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled + echo. coverage to run coverage check of the documentation if enabled goto end ) @@ -47,6 +48,14 @@ if "%1" == "clean" ( ) +REM Check if sphinx-build is available and fallback to Python version if any +%SPHINXBUILD% 2> nul +if errorlevel 9009 goto sphinx_python +goto sphinx_ok + +:sphinx_python + +set SPHINXBUILD=python -m sphinx.__init__ %SPHINXBUILD% 2> nul if errorlevel 9009 ( echo. @@ -60,6 +69,9 @@ if errorlevel 9009 ( exit /b 1 ) +:sphinx_ok + + if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 @@ -115,9 +127,9 @@ if "%1" == "qthelp" ( echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Mopidy-Touchscreen.qhcp + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\MopidyTouchscreen.qhcp echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Mopidy-Touchscreen.ghc + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\MopidyTouchscreen.ghc goto end ) @@ -149,7 +161,7 @@ if "%1" == "latexpdf" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf - cd %BUILDDIR%/.. + cd %~dp0 echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end @@ -159,7 +171,7 @@ if "%1" == "latexpdfja" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf-ja - cd %BUILDDIR%/.. + cd %~dp0 echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end @@ -223,6 +235,15 @@ results in %BUILDDIR%/doctest/output.txt. goto end ) +if "%1" == "coverage" ( + %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage + if errorlevel 1 exit /b 1 + echo. + echo.Testing of coverage in the sources finished, look at the ^ +results in %BUILDDIR%/coverage/python.txt. + goto end +) + if "%1" == "xml" ( %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml if errorlevel 1 exit /b 1