From 83f18a220aace6bc438c1c788201d67ff60f6fc3 Mon Sep 17 00:00:00 2001 From: Thomas Kemmer Date: Tue, 8 Dec 2015 15:12:51 +0100 Subject: [PATCH] fixup --- CHANGES.rst | 13 ++- docs/changelog.rst | 6 + docs/conf.py | 267 ++++----------------------------------------- docs/index.rst | 1 + setup.cfg | 2 +- 5 files changed, 39 insertions(+), 250 deletions(-) create mode 100644 docs/changelog.rst diff --git a/CHANGES.rst b/CHANGES.rst index 0ceac3e..766825c 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,8 +1,19 @@ v2.0.0 (UNRELEASED) ------------------- +- Support configurable sort criteria when browsing collections via + "browse views". + +- Include collections in browse results. + +- Add support for ``LibraryProvider.get_images()``. + +- Drop support for deprecated ``Album.images``. + - Drop special handling of bookmarks. +- Cache root collections. + v1.3.0 (2015-09-11) ------------------- @@ -83,7 +94,7 @@ v1.0.0 (2014-09-26) v0.5.0 (2014-02-28) ----------------- +------------------- - Update `README` with link to documentation. diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..8c135c7 --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,6 @@ +Change Log +======================================================================== + +This page lists all major changes to Mopidy-Internetarchive. + +.. include:: ../CHANGES.rst diff --git a/docs/conf.py b/docs/conf.py index d394a90..8306767 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,262 +1,33 @@ -# -*- coding: utf-8 -*- -# -# Mopidy-InternetArchive documentation build configuration file, created by -# sphinx-quickstart on Sat Feb 22 11:33:06 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, os, re - -# 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('.')) - -# -- Custom Sphinx object types ----------------------------------------------- - def setup(app): - from sphinx.ext.autodoc import cut_lines - #app.connect(b'autodoc-process-docstring', cut_lines(4, what=['module'])) app.add_object_type( 'confval', 'confval', objname='configuration value', - indextemplate='pair: %s; configuration value') + indextemplate='pair: %s; configuration value' + ) + def get_version(filename): - content = open(filename).read() - metadata = dict(re.findall("__([a-z]+)__ = '([^']+)'", content)) + import re + with open(filename) as fh: + metadata = dict(re.findall(r"__([a-z]+)__ = '([^']+)'", fh.read())) return metadata['version'] -# -- 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 = ['sphinx.ext.intersphinx'] - -# 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-InternetArchive' -copyright = u'2014, 2015 Thomas Kemmer' - -# 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 = get_version('../mopidy_internetarchive/__init__.py') - -# The full version, including alpha/beta/rc tags. +project = 'Mopidy-InternetArchive' +copyright = '2014, 2015 Thomas Kemmer' +version = get_version(b'../mopidy_internetarchive/__init__.py') release = version -# 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 = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. +master_doc = 'index' 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'] - -# 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-InternetArchivedoc' - - -# -- 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]). -latex_documents = [ - ('index', 'Mopidy-InternetArchive.tex', u'Mopidy-InternetArchive Documentation', - u'Thomas Kemmer', '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-internetarchive', u'Mopidy-InternetArchive Documentation', - [u'Thomas Kemmer'], 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-InternetArchive', u'Mopidy-InternetArchive Documentation', - u'Thomas Kemmer', 'Mopidy-InternetArchive', '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' - +latex_documents = [( + 'index', 'Mopidy-InternetArchive.tex', + 'Mopidy-InternetArchive Documentation', + 'Thomas Kemmer', 'manual' +)] -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'http://docs.python.org/': None} +man_pages = [( + 'index', 'mopidy-internetarchive', 'Mopidy-InternetArchive Documentation', + ['Thomas Kemmer'], 1 +)] diff --git a/docs/index.rst b/docs/index.rst index 131541c..5b58e97 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,6 +19,7 @@ collection. intro install config + changelog license diff --git a/setup.cfg b/setup.cfg index d282eb2..2df6ede 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [flake8] application-import-names = mopidy_local_sqlite,tests -exclude = .git,.tox,docs +exclude = .git,.tox [wheel] universal = 1