diff --git a/.gitignore b/.gitignore index 74b1a7d..fc71e23 100644 --- a/.gitignore +++ b/.gitignore @@ -63,6 +63,7 @@ instance/ # Sphinx documentation docs/_build/ +docs/build/ # PyBuilder target/ diff --git a/Makefile b/Makefile index 1f226e0..fc9ee90 100644 --- a/Makefile +++ b/Makefile @@ -4,3 +4,7 @@ build: run: | build docker run -it clay +.PHONY: docs +docs: + make -C docs html + diff --git a/clay/player.py b/clay/player.py index 4380d32..bf8b2a7 100644 --- a/clay/player.py +++ b/clay/player.py @@ -386,6 +386,6 @@ class Player(object): def seek_absolute(self, position): """ Seek to absolute position. - *position* must be a ``float`` in range ```[0;1]`. + *position* must be a ``float`` in range ``[0;1]``. """ self.media_player.set_position(position) diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4daeec --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = Clay +SOURCEDIR = source +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) \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..df7c936 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,184 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Clay documentation build configuration file, created by +# sphinx-quickstart on Sat Jan 6 13:35:04 2018. +# +# 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. + +# 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('../..')) +try: + from unittest.mock import MagicMock +except ImportError: + from mock import Mock as MagicMock + + +# -- 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.autodoc', + 'sphinx.ext.todo', + 'sphinx.ext.viewcode' +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'Clay' +copyright = '2018, Andrew Dunai' +author = 'Andrew Dunai' + +# 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 = '1.0a1' +# The full version, including alpha/beta/rc tags. +release = '1.0a1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- 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 = 'sphinx_rtd_theme' + +# 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 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'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Claydoc' + + +# -- 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': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# 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 = [ + (master_doc, 'Clay.tex', 'Clay Documentation', + 'Andrew Dunai', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'clay', 'Clay Documentation', + [author], 1) +] + + +# -- 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 = [ + (master_doc, 'Clay', 'Clay Documentation', + author, 'Clay', 'One line description of project.', + 'Miscellaneous'), +] + + +class Mock(MagicMock): + @classmethod + def __getattr__(cls, name): + return MagicMock() + +# MOCK_MODULES = ['gi', 'gi.repository', 'urwid'] +# sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) + diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..2b8bdb5 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,27 @@ +.. Clay documentation master file, created by + sphinx-quickstart on Sat Jan 6 13:35:04 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Clay's documentation! +================================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + ref/app + ref/gp + ref/player + ref/songlist + ref/playbar + ref/mylibrary + ref/myplaylists + ref/playerqueue + ref/settings + ref/pages + ref/notifications + ref/hotkeys + ref/eventhook + ref/meta + diff --git a/docs/source/ref/app.rst b/docs/source/ref/app.rst new file mode 100644 index 0000000..997c296 --- /dev/null +++ b/docs/source/ref/app.rst @@ -0,0 +1,8 @@ +app.py +###### + +.. automodule:: clay.app + :members: + :private-members: + :special-members: + diff --git a/docs/source/ref/eventhook.rst b/docs/source/ref/eventhook.rst new file mode 100644 index 0000000..4999b2f --- /dev/null +++ b/docs/source/ref/eventhook.rst @@ -0,0 +1,8 @@ +eventhook.py +############ + +.. automodule:: clay.eventhook + :members: + :private-members: + :special-members: + diff --git a/docs/source/ref/gp.rst b/docs/source/ref/gp.rst new file mode 100644 index 0000000..c179a3d --- /dev/null +++ b/docs/source/ref/gp.rst @@ -0,0 +1,8 @@ +gp.py +##### + +.. automodule:: clay.gp + :members: + :private-members: + :special-members: + diff --git a/docs/source/ref/hotkeys.rst b/docs/source/ref/hotkeys.rst new file mode 100644 index 0000000..af31d72 --- /dev/null +++ b/docs/source/ref/hotkeys.rst @@ -0,0 +1,8 @@ +hotkeys.py +########## + +.. automodule:: clay.hotkeys + :members: + :private-members: + :special-members: + diff --git a/docs/source/ref/meta.rst b/docs/source/ref/meta.rst new file mode 100644 index 0000000..e4e5e3a --- /dev/null +++ b/docs/source/ref/meta.rst @@ -0,0 +1,8 @@ +meta.py +####### + +.. automodule:: clay.meta + :members: + :private-members: + :special-members: + diff --git a/docs/source/ref/mylibrary.rst b/docs/source/ref/mylibrary.rst new file mode 100644 index 0000000..a0073d2 --- /dev/null +++ b/docs/source/ref/mylibrary.rst @@ -0,0 +1,8 @@ +mylibrary.py +############ + +.. automodule:: clay.mylibrary + :members: + :private-members: + :special-members: + diff --git a/docs/source/ref/myplaylists.rst b/docs/source/ref/myplaylists.rst new file mode 100644 index 0000000..9d4587f --- /dev/null +++ b/docs/source/ref/myplaylists.rst @@ -0,0 +1,8 @@ +myplaylists.py +############## + +.. automodule:: clay.myplaylists + :members: + :private-members: + :special-members: + diff --git a/docs/source/ref/notifications.rst b/docs/source/ref/notifications.rst new file mode 100644 index 0000000..5265bf3 --- /dev/null +++ b/docs/source/ref/notifications.rst @@ -0,0 +1,8 @@ +notifications.py +################ + +.. automodule:: clay.notifications + :members: + :private-members: + :special-members: + diff --git a/docs/source/ref/pages.rst b/docs/source/ref/pages.rst new file mode 100644 index 0000000..78b500b --- /dev/null +++ b/docs/source/ref/pages.rst @@ -0,0 +1,8 @@ +pages.py +######## + +.. automodule:: clay.pages + :members: + :private-members: + :special-members: + diff --git a/docs/source/ref/playbar.rst b/docs/source/ref/playbar.rst new file mode 100644 index 0000000..bb726be --- /dev/null +++ b/docs/source/ref/playbar.rst @@ -0,0 +1,8 @@ +playbar.py +########## + +.. automodule:: clay.playbar + :members: + :private-members: + :special-members: + diff --git a/docs/source/ref/player.rst b/docs/source/ref/player.rst new file mode 100644 index 0000000..60eb423 --- /dev/null +++ b/docs/source/ref/player.rst @@ -0,0 +1,8 @@ +player.py +######### + +.. automodule:: clay.player + :members: + :private-members: + :special-members: + diff --git a/docs/source/ref/playerqueue.rst b/docs/source/ref/playerqueue.rst new file mode 100644 index 0000000..a36a97b --- /dev/null +++ b/docs/source/ref/playerqueue.rst @@ -0,0 +1,8 @@ +playerqueue.py +############## + +.. automodule:: clay.playerqueue + :members: + :private-members: + :special-members: + diff --git a/docs/source/ref/settings.rst b/docs/source/ref/settings.rst new file mode 100644 index 0000000..3d4a730 --- /dev/null +++ b/docs/source/ref/settings.rst @@ -0,0 +1,8 @@ +settings.py +########### + +.. automodule:: clay.settings + :members: + :private-members: + :special-members: + diff --git a/docs/source/ref/songlist.rst b/docs/source/ref/songlist.rst new file mode 100644 index 0000000..6005edf --- /dev/null +++ b/docs/source/ref/songlist.rst @@ -0,0 +1,8 @@ +songlist.py +########### + +.. automodule:: clay.songlist + :members: + :private-members: + :special-members: +